@@ -18,14 +18,14 @@ |
||
18 | 18 | interface ContextInterface |
19 | 19 | { |
20 | 20 | |
21 | - /** |
|
22 | - * @return string |
|
23 | - */ |
|
24 | - public function slug(); |
|
21 | + /** |
|
22 | + * @return string |
|
23 | + */ |
|
24 | + public function slug(); |
|
25 | 25 | |
26 | 26 | |
27 | - /** |
|
28 | - * @return string |
|
29 | - */ |
|
30 | - public function description(); |
|
27 | + /** |
|
28 | + * @return string |
|
29 | + */ |
|
30 | + public function description(); |
|
31 | 31 | } |
@@ -23,14 +23,14 @@ |
||
23 | 23 | class CartFactory |
24 | 24 | { |
25 | 25 | |
26 | - /** |
|
27 | - * @return EE_Cart |
|
28 | - * @throws InvalidArgumentException |
|
29 | - * @throws InvalidInterfaceException |
|
30 | - * @throws InvalidDataTypeException |
|
31 | - */ |
|
32 | - public static function getCart() |
|
33 | - { |
|
34 | - return LoaderFactory::getLoader()->getShared('EE_Cart'); |
|
35 | - } |
|
26 | + /** |
|
27 | + * @return EE_Cart |
|
28 | + * @throws InvalidArgumentException |
|
29 | + * @throws InvalidInterfaceException |
|
30 | + * @throws InvalidDataTypeException |
|
31 | + */ |
|
32 | + public static function getCart() |
|
33 | + { |
|
34 | + return LoaderFactory::getLoader()->getShared('EE_Cart'); |
|
35 | + } |
|
36 | 36 | } |
@@ -25,17 +25,17 @@ |
||
25 | 25 | class ModelFactory |
26 | 26 | { |
27 | 27 | |
28 | - /** |
|
29 | - * @param string $model_name |
|
30 | - * @return bool|EEM_Base |
|
31 | - * @throws EE_Error |
|
32 | - * @throws InvalidDataTypeException |
|
33 | - * @throws InvalidInterfaceException |
|
34 | - * @throws InvalidArgumentException |
|
35 | - * @throws ReflectionException |
|
36 | - */ |
|
37 | - public static function getModel($model_name) |
|
38 | - { |
|
39 | - return EE_Registry::instance()->load_model($model_name); |
|
40 | - } |
|
28 | + /** |
|
29 | + * @param string $model_name |
|
30 | + * @return bool|EEM_Base |
|
31 | + * @throws EE_Error |
|
32 | + * @throws InvalidDataTypeException |
|
33 | + * @throws InvalidInterfaceException |
|
34 | + * @throws InvalidArgumentException |
|
35 | + * @throws ReflectionException |
|
36 | + */ |
|
37 | + public static function getModel($model_name) |
|
38 | + { |
|
39 | + return EE_Registry::instance()->load_model($model_name); |
|
40 | + } |
|
41 | 41 | } |
@@ -66,24 +66,24 @@ discard block |
||
66 | 66 | public function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false) |
67 | 67 | { |
68 | 68 | // if the $_available_spaces array has not been set up yet... |
69 | - if (! isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
69 | + if ( ! isset($this->available_spaces['tickets'][$ticket->ID()])) { |
|
70 | 70 | $this->setInitialTicketDatetimeAvailability($ticket); |
71 | 71 | } |
72 | 72 | $available_spaces = $ticket->qty() - $ticket->sold(); |
73 | - if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
73 | + if (isset($this->available_spaces['tickets'][$ticket->ID()])) { |
|
74 | 74 | // loop thru tickets, which will ALSO include individual ticket records AND a total |
75 | - foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
75 | + foreach ($this->available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) { |
|
76 | 76 | // if we want the original datetime availability BEFORE we started subtracting tickets ? |
77 | 77 | if ($get_original_ticket_spaces) { |
78 | 78 | // then grab the available spaces from the "tickets" array |
79 | 79 | // and compare with the above to get the lowest number |
80 | 80 | $available_spaces = min( |
81 | 81 | $available_spaces, |
82 | - $this->available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ] |
|
82 | + $this->available_spaces['tickets'][$ticket->ID()][$DTD_ID] |
|
83 | 83 | ); |
84 | 84 | } else { |
85 | 85 | // we want the updated ticket availability as stored in the "datetimes" array |
86 | - $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][ $DTD_ID ]); |
|
86 | + $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][$DTD_ID]); |
|
87 | 87 | } |
88 | 88 | } |
89 | 89 | } |
@@ -114,7 +114,7 @@ discard block |
||
114 | 114 | 'order_by' => array('DTT_EVT_start' => 'ASC'), |
115 | 115 | ) |
116 | 116 | ); |
117 | - if (! empty($datetimes)) { |
|
117 | + if ( ! empty($datetimes)) { |
|
118 | 118 | // now loop thru all of the datetimes |
119 | 119 | foreach ($datetimes as $datetime) { |
120 | 120 | if ($datetime instanceof EE_Datetime) { |
@@ -122,17 +122,17 @@ discard block |
||
122 | 122 | $spaces_remaining = $datetime->spaces_remaining(); |
123 | 123 | // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold |
124 | 124 | // or the datetime spaces remaining) to this ticket using the datetime ID as the key |
125 | - $this->available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min( |
|
125 | + $this->available_spaces['tickets'][$ticket->ID()][$datetime->ID()] = min( |
|
126 | 126 | $ticket->qty() - $ticket->sold(), |
127 | 127 | $spaces_remaining |
128 | 128 | ); |
129 | 129 | // if the remaining spaces for this datetime is already set, |
130 | 130 | // then compare that against the datetime spaces remaining, and take the lowest number, |
131 | 131 | // else just take the datetime spaces remaining, and assign to the datetimes array |
132 | - $this->available_spaces['datetimes'][ $datetime->ID() ] = isset( |
|
133 | - $this->available_spaces['datetimes'][ $datetime->ID() ] |
|
132 | + $this->available_spaces['datetimes'][$datetime->ID()] = isset( |
|
133 | + $this->available_spaces['datetimes'][$datetime->ID()] |
|
134 | 134 | ) |
135 | - ? min($this->available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining) |
|
135 | + ? min($this->available_spaces['datetimes'][$datetime->ID()], $spaces_remaining) |
|
136 | 136 | : $spaces_remaining; |
137 | 137 | } |
138 | 138 | } |
@@ -148,11 +148,11 @@ discard block |
||
148 | 148 | */ |
149 | 149 | public function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0) |
150 | 150 | { |
151 | - if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
151 | + if (isset($this->available_spaces['tickets'][$ticket->ID()])) { |
|
152 | 152 | // loop thru tickets, which will ALSO include individual ticket records AND a total |
153 | - foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
153 | + foreach ($this->available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) { |
|
154 | 154 | // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to, |
155 | - $this->available_spaces['datetimes'][ $DTD_ID ] -= $qty; |
|
155 | + $this->available_spaces['datetimes'][$DTD_ID] -= $qty; |
|
156 | 156 | } |
157 | 157 | } |
158 | 158 | } |
@@ -22,217 +22,217 @@ |
||
22 | 22 | class TicketDatetimeAvailabilityTracker |
23 | 23 | { |
24 | 24 | |
25 | - /** |
|
26 | - * array of datetimes and the spaces available for them |
|
27 | - * |
|
28 | - * @var array[][] |
|
29 | - */ |
|
30 | - private $available_spaces = array(); |
|
31 | - |
|
32 | - /** |
|
33 | - * @var EEM_Datetime $datetime_model |
|
34 | - */ |
|
35 | - private $datetime_model; |
|
36 | - |
|
37 | - |
|
38 | - /** |
|
39 | - * TicketDatetimeAvailabilityTracker constructor. |
|
40 | - * |
|
41 | - * @param EEM_Datetime $datetime_model |
|
42 | - */ |
|
43 | - public function __construct(EEM_Datetime $datetime_model) |
|
44 | - { |
|
45 | - $this->datetime_model = $datetime_model; |
|
46 | - } |
|
47 | - |
|
48 | - |
|
49 | - /** |
|
50 | - * ticketDatetimeAvailability |
|
51 | - * creates an array of tickets plus all of the datetimes available to each ticket |
|
52 | - * and tracks the spaces remaining for each of those datetimes |
|
53 | - * |
|
54 | - * @param EE_Ticket $ticket - selected ticket |
|
55 | - * @param bool $get_original_ticket_spaces |
|
56 | - * @return int |
|
57 | - * @throws EE_Error |
|
58 | - * @throws InvalidArgumentException |
|
59 | - * @throws InvalidDataTypeException |
|
60 | - * @throws InvalidInterfaceException |
|
61 | - */ |
|
62 | - public function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false) |
|
63 | - { |
|
64 | - // if the $_available_spaces array has not been set up yet... |
|
65 | - if (! isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
66 | - $this->setInitialTicketDatetimeAvailability($ticket); |
|
67 | - } |
|
68 | - $available_spaces = $ticket->qty() - $ticket->sold(); |
|
69 | - if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
70 | - // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
71 | - foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
72 | - // if we want the original datetime availability BEFORE we started subtracting tickets ? |
|
73 | - if ($get_original_ticket_spaces) { |
|
74 | - // then grab the available spaces from the "tickets" array |
|
75 | - // and compare with the above to get the lowest number |
|
76 | - $available_spaces = min( |
|
77 | - $available_spaces, |
|
78 | - $this->available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ] |
|
79 | - ); |
|
80 | - } else { |
|
81 | - // we want the updated ticket availability as stored in the "datetimes" array |
|
82 | - $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][ $DTD_ID ]); |
|
83 | - } |
|
84 | - } |
|
85 | - } |
|
86 | - return $available_spaces; |
|
87 | - } |
|
88 | - |
|
89 | - |
|
90 | - /** |
|
91 | - * @param EE_Ticket $ticket |
|
92 | - * @return void |
|
93 | - * @throws InvalidArgumentException |
|
94 | - * @throws InvalidInterfaceException |
|
95 | - * @throws InvalidDataTypeException |
|
96 | - * @throws EE_Error |
|
97 | - */ |
|
98 | - private function setInitialTicketDatetimeAvailability(EE_Ticket $ticket) |
|
99 | - { |
|
100 | - // first, get all of the datetimes that are available to this ticket |
|
101 | - $datetimes = $ticket->get_many_related( |
|
102 | - 'Datetime', |
|
103 | - array( |
|
104 | - array( |
|
105 | - 'DTT_EVT_end' => array( |
|
106 | - '>=', |
|
107 | - $this->datetime_model->current_time_for_query('DTT_EVT_end'), |
|
108 | - ), |
|
109 | - ), |
|
110 | - 'order_by' => array('DTT_EVT_start' => 'ASC'), |
|
111 | - ) |
|
112 | - ); |
|
113 | - if (! empty($datetimes)) { |
|
114 | - // now loop thru all of the datetimes |
|
115 | - foreach ($datetimes as $datetime) { |
|
116 | - if ($datetime instanceof EE_Datetime) { |
|
117 | - // the number of spaces available for the datetime without considering individual ticket quantities |
|
118 | - $spaces_remaining = $datetime->spaces_remaining(); |
|
119 | - // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold |
|
120 | - // or the datetime spaces remaining) to this ticket using the datetime ID as the key |
|
121 | - $this->available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min( |
|
122 | - $ticket->qty() - $ticket->sold(), |
|
123 | - $spaces_remaining |
|
124 | - ); |
|
125 | - // if the remaining spaces for this datetime is already set, |
|
126 | - // then compare that against the datetime spaces remaining, and take the lowest number, |
|
127 | - // else just take the datetime spaces remaining, and assign to the datetimes array |
|
128 | - $this->available_spaces['datetimes'][ $datetime->ID() ] = isset( |
|
129 | - $this->available_spaces['datetimes'][ $datetime->ID() ] |
|
130 | - ) |
|
131 | - ? min($this->available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining) |
|
132 | - : $spaces_remaining; |
|
133 | - } |
|
134 | - } |
|
135 | - } |
|
136 | - } |
|
137 | - |
|
138 | - |
|
139 | - /** |
|
140 | - * @param EE_Ticket $ticket |
|
141 | - * @param int $qty |
|
142 | - * @return void |
|
143 | - * @throws EE_Error |
|
144 | - */ |
|
145 | - public function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0) |
|
146 | - { |
|
147 | - if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
148 | - // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
149 | - foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
150 | - // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to, |
|
151 | - $this->available_spaces['datetimes'][ $DTD_ID ] -= $qty; |
|
152 | - } |
|
153 | - } |
|
154 | - } |
|
155 | - |
|
156 | - |
|
157 | - /** |
|
158 | - * @param EE_Ticket $ticket |
|
159 | - * @param $qty |
|
160 | - * @param int $total_ticket_count |
|
161 | - * @throws EE_Error |
|
162 | - * @throws InvalidArgumentException |
|
163 | - * @throws InvalidDataTypeException |
|
164 | - * @throws InvalidInterfaceException |
|
165 | - */ |
|
166 | - public function processAvailabilityError(EE_Ticket $ticket, $qty, $total_ticket_count = 1) |
|
167 | - { |
|
168 | - // tickets can not be purchased but let's find the exact number left |
|
169 | - // for the last ticket selected PRIOR to subtracting tickets |
|
170 | - $available_spaces = $this->ticketDatetimeAvailability($ticket, true); |
|
171 | - // greedy greedy greedy eh? |
|
172 | - if ($available_spaces > 0) { |
|
173 | - if ( |
|
174 | - apply_filters( |
|
175 | - 'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error', |
|
176 | - true, |
|
177 | - $ticket, |
|
178 | - $qty, |
|
179 | - $available_spaces |
|
180 | - ) |
|
181 | - ) { |
|
182 | - $this->availabilityError( |
|
183 | - $available_spaces, |
|
184 | - $total_ticket_count |
|
185 | - ); |
|
186 | - } |
|
187 | - } else { |
|
188 | - EE_Error::add_error( |
|
189 | - esc_html__( |
|
190 | - 'We\'re sorry, but there are no available spaces left for this event at this particular date and time.', |
|
191 | - 'event_espresso' |
|
192 | - ), |
|
193 | - __FILE__, |
|
194 | - __FUNCTION__, |
|
195 | - __LINE__ |
|
196 | - ); |
|
197 | - } |
|
198 | - } |
|
199 | - |
|
200 | - |
|
201 | - /** |
|
202 | - * @param int $available_spaces |
|
203 | - * @param int $total_ticket_count |
|
204 | - */ |
|
205 | - private function availabilityError($available_spaces = 1, $total_ticket_count = 1) |
|
206 | - { |
|
207 | - // add error messaging - we're using the _n function that will generate |
|
208 | - // the appropriate singular or plural message based on the number of $available_spaces |
|
209 | - if ($total_ticket_count) { |
|
210 | - $msg = sprintf( |
|
211 | - esc_html( |
|
212 | - _n( |
|
213 | - 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
214 | - 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
215 | - $available_spaces, |
|
216 | - 'event_espresso' |
|
217 | - ) |
|
218 | - ), |
|
219 | - $available_spaces, |
|
220 | - '<br />' |
|
221 | - ); |
|
222 | - } else { |
|
223 | - $msg = sprintf( |
|
224 | - esc_html( |
|
225 | - _n( |
|
226 | - 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
227 | - 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
228 | - $available_spaces, |
|
229 | - 'event_espresso' |
|
230 | - ) |
|
231 | - ), |
|
232 | - $available_spaces, |
|
233 | - '<br />' |
|
234 | - ); |
|
235 | - } |
|
236 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
237 | - } |
|
25 | + /** |
|
26 | + * array of datetimes and the spaces available for them |
|
27 | + * |
|
28 | + * @var array[][] |
|
29 | + */ |
|
30 | + private $available_spaces = array(); |
|
31 | + |
|
32 | + /** |
|
33 | + * @var EEM_Datetime $datetime_model |
|
34 | + */ |
|
35 | + private $datetime_model; |
|
36 | + |
|
37 | + |
|
38 | + /** |
|
39 | + * TicketDatetimeAvailabilityTracker constructor. |
|
40 | + * |
|
41 | + * @param EEM_Datetime $datetime_model |
|
42 | + */ |
|
43 | + public function __construct(EEM_Datetime $datetime_model) |
|
44 | + { |
|
45 | + $this->datetime_model = $datetime_model; |
|
46 | + } |
|
47 | + |
|
48 | + |
|
49 | + /** |
|
50 | + * ticketDatetimeAvailability |
|
51 | + * creates an array of tickets plus all of the datetimes available to each ticket |
|
52 | + * and tracks the spaces remaining for each of those datetimes |
|
53 | + * |
|
54 | + * @param EE_Ticket $ticket - selected ticket |
|
55 | + * @param bool $get_original_ticket_spaces |
|
56 | + * @return int |
|
57 | + * @throws EE_Error |
|
58 | + * @throws InvalidArgumentException |
|
59 | + * @throws InvalidDataTypeException |
|
60 | + * @throws InvalidInterfaceException |
|
61 | + */ |
|
62 | + public function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false) |
|
63 | + { |
|
64 | + // if the $_available_spaces array has not been set up yet... |
|
65 | + if (! isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
66 | + $this->setInitialTicketDatetimeAvailability($ticket); |
|
67 | + } |
|
68 | + $available_spaces = $ticket->qty() - $ticket->sold(); |
|
69 | + if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
70 | + // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
71 | + foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
72 | + // if we want the original datetime availability BEFORE we started subtracting tickets ? |
|
73 | + if ($get_original_ticket_spaces) { |
|
74 | + // then grab the available spaces from the "tickets" array |
|
75 | + // and compare with the above to get the lowest number |
|
76 | + $available_spaces = min( |
|
77 | + $available_spaces, |
|
78 | + $this->available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ] |
|
79 | + ); |
|
80 | + } else { |
|
81 | + // we want the updated ticket availability as stored in the "datetimes" array |
|
82 | + $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][ $DTD_ID ]); |
|
83 | + } |
|
84 | + } |
|
85 | + } |
|
86 | + return $available_spaces; |
|
87 | + } |
|
88 | + |
|
89 | + |
|
90 | + /** |
|
91 | + * @param EE_Ticket $ticket |
|
92 | + * @return void |
|
93 | + * @throws InvalidArgumentException |
|
94 | + * @throws InvalidInterfaceException |
|
95 | + * @throws InvalidDataTypeException |
|
96 | + * @throws EE_Error |
|
97 | + */ |
|
98 | + private function setInitialTicketDatetimeAvailability(EE_Ticket $ticket) |
|
99 | + { |
|
100 | + // first, get all of the datetimes that are available to this ticket |
|
101 | + $datetimes = $ticket->get_many_related( |
|
102 | + 'Datetime', |
|
103 | + array( |
|
104 | + array( |
|
105 | + 'DTT_EVT_end' => array( |
|
106 | + '>=', |
|
107 | + $this->datetime_model->current_time_for_query('DTT_EVT_end'), |
|
108 | + ), |
|
109 | + ), |
|
110 | + 'order_by' => array('DTT_EVT_start' => 'ASC'), |
|
111 | + ) |
|
112 | + ); |
|
113 | + if (! empty($datetimes)) { |
|
114 | + // now loop thru all of the datetimes |
|
115 | + foreach ($datetimes as $datetime) { |
|
116 | + if ($datetime instanceof EE_Datetime) { |
|
117 | + // the number of spaces available for the datetime without considering individual ticket quantities |
|
118 | + $spaces_remaining = $datetime->spaces_remaining(); |
|
119 | + // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold |
|
120 | + // or the datetime spaces remaining) to this ticket using the datetime ID as the key |
|
121 | + $this->available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min( |
|
122 | + $ticket->qty() - $ticket->sold(), |
|
123 | + $spaces_remaining |
|
124 | + ); |
|
125 | + // if the remaining spaces for this datetime is already set, |
|
126 | + // then compare that against the datetime spaces remaining, and take the lowest number, |
|
127 | + // else just take the datetime spaces remaining, and assign to the datetimes array |
|
128 | + $this->available_spaces['datetimes'][ $datetime->ID() ] = isset( |
|
129 | + $this->available_spaces['datetimes'][ $datetime->ID() ] |
|
130 | + ) |
|
131 | + ? min($this->available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining) |
|
132 | + : $spaces_remaining; |
|
133 | + } |
|
134 | + } |
|
135 | + } |
|
136 | + } |
|
137 | + |
|
138 | + |
|
139 | + /** |
|
140 | + * @param EE_Ticket $ticket |
|
141 | + * @param int $qty |
|
142 | + * @return void |
|
143 | + * @throws EE_Error |
|
144 | + */ |
|
145 | + public function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0) |
|
146 | + { |
|
147 | + if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
148 | + // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
149 | + foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
150 | + // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to, |
|
151 | + $this->available_spaces['datetimes'][ $DTD_ID ] -= $qty; |
|
152 | + } |
|
153 | + } |
|
154 | + } |
|
155 | + |
|
156 | + |
|
157 | + /** |
|
158 | + * @param EE_Ticket $ticket |
|
159 | + * @param $qty |
|
160 | + * @param int $total_ticket_count |
|
161 | + * @throws EE_Error |
|
162 | + * @throws InvalidArgumentException |
|
163 | + * @throws InvalidDataTypeException |
|
164 | + * @throws InvalidInterfaceException |
|
165 | + */ |
|
166 | + public function processAvailabilityError(EE_Ticket $ticket, $qty, $total_ticket_count = 1) |
|
167 | + { |
|
168 | + // tickets can not be purchased but let's find the exact number left |
|
169 | + // for the last ticket selected PRIOR to subtracting tickets |
|
170 | + $available_spaces = $this->ticketDatetimeAvailability($ticket, true); |
|
171 | + // greedy greedy greedy eh? |
|
172 | + if ($available_spaces > 0) { |
|
173 | + if ( |
|
174 | + apply_filters( |
|
175 | + 'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error', |
|
176 | + true, |
|
177 | + $ticket, |
|
178 | + $qty, |
|
179 | + $available_spaces |
|
180 | + ) |
|
181 | + ) { |
|
182 | + $this->availabilityError( |
|
183 | + $available_spaces, |
|
184 | + $total_ticket_count |
|
185 | + ); |
|
186 | + } |
|
187 | + } else { |
|
188 | + EE_Error::add_error( |
|
189 | + esc_html__( |
|
190 | + 'We\'re sorry, but there are no available spaces left for this event at this particular date and time.', |
|
191 | + 'event_espresso' |
|
192 | + ), |
|
193 | + __FILE__, |
|
194 | + __FUNCTION__, |
|
195 | + __LINE__ |
|
196 | + ); |
|
197 | + } |
|
198 | + } |
|
199 | + |
|
200 | + |
|
201 | + /** |
|
202 | + * @param int $available_spaces |
|
203 | + * @param int $total_ticket_count |
|
204 | + */ |
|
205 | + private function availabilityError($available_spaces = 1, $total_ticket_count = 1) |
|
206 | + { |
|
207 | + // add error messaging - we're using the _n function that will generate |
|
208 | + // the appropriate singular or plural message based on the number of $available_spaces |
|
209 | + if ($total_ticket_count) { |
|
210 | + $msg = sprintf( |
|
211 | + esc_html( |
|
212 | + _n( |
|
213 | + 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
214 | + 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
215 | + $available_spaces, |
|
216 | + 'event_espresso' |
|
217 | + ) |
|
218 | + ), |
|
219 | + $available_spaces, |
|
220 | + '<br />' |
|
221 | + ); |
|
222 | + } else { |
|
223 | + $msg = sprintf( |
|
224 | + esc_html( |
|
225 | + _n( |
|
226 | + 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
227 | + 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
228 | + $available_spaces, |
|
229 | + 'event_espresso' |
|
230 | + ) |
|
231 | + ), |
|
232 | + $available_spaces, |
|
233 | + '<br />' |
|
234 | + ); |
|
235 | + } |
|
236 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
237 | + } |
|
238 | 238 | } |
@@ -130,7 +130,7 @@ discard block |
||
130 | 130 | */ |
131 | 131 | private function setName($name) |
132 | 132 | { |
133 | - if (! is_string($name)) { |
|
133 | + if ( ! is_string($name)) { |
|
134 | 134 | throw new InvalidDataTypeException('$name', $name, 'string'); |
135 | 135 | } |
136 | 136 | $this->name = sanitize_key($name); |
@@ -154,7 +154,7 @@ discard block |
||
154 | 154 | */ |
155 | 155 | private function setMessage($message) |
156 | 156 | { |
157 | - if (! is_string($message)) { |
|
157 | + if ( ! is_string($message)) { |
|
158 | 158 | throw new InvalidDataTypeException('$message', $message, 'string'); |
159 | 159 | } |
160 | 160 | global $allowedtags; |
@@ -200,7 +200,7 @@ discard block |
||
200 | 200 | */ |
201 | 201 | private function setCapability($capability) |
202 | 202 | { |
203 | - if (! is_string($capability)) { |
|
203 | + if ( ! is_string($capability)) { |
|
204 | 204 | throw new InvalidDataTypeException('$capability', $capability, 'string'); |
205 | 205 | } |
206 | 206 | $this->capability = ! empty($capability) ? $capability : 'manage_options'; |
@@ -224,7 +224,7 @@ discard block |
||
224 | 224 | */ |
225 | 225 | private function setCapContext($cap_context) |
226 | 226 | { |
227 | - if (! is_string($cap_context)) { |
|
227 | + if ( ! is_string($cap_context)) { |
|
228 | 228 | throw new InvalidDataTypeException('$cap_context', $cap_context, 'string'); |
229 | 229 | } |
230 | 230 | $this->cap_context = ! empty($cap_context) ? $cap_context : 'view persistent admin notice'; |
@@ -258,7 +258,7 @@ discard block |
||
258 | 258 | */ |
259 | 259 | public function getCapCheck() |
260 | 260 | { |
261 | - if (! $this->cap_check instanceof CapCheckInterface) { |
|
261 | + if ( ! $this->cap_check instanceof CapCheckInterface) { |
|
262 | 262 | $this->setCapCheck( |
263 | 263 | new CapCheck( |
264 | 264 | $this->capability, |
@@ -343,10 +343,10 @@ discard block |
||
343 | 343 | */ |
344 | 344 | public function confirmRegistered() |
345 | 345 | { |
346 | - if (! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) { |
|
346 | + if ( ! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) { |
|
347 | 347 | PersistentAdminNoticeManager::loadRegisterAndSaveNotices(); |
348 | 348 | } |
349 | - if (! $this->registered && WP_DEBUG) { |
|
349 | + if ( ! $this->registered && WP_DEBUG) { |
|
350 | 350 | throw new DomainException( |
351 | 351 | sprintf( |
352 | 352 | esc_html__( |
@@ -25,316 +25,316 @@ |
||
25 | 25 | class PersistentAdminNotice implements RequiresCapCheckInterface |
26 | 26 | { |
27 | 27 | |
28 | - /** |
|
29 | - * @var string $name |
|
30 | - */ |
|
31 | - protected $name = ''; |
|
32 | - |
|
33 | - /** |
|
34 | - * @var string $message |
|
35 | - */ |
|
36 | - protected $message = ''; |
|
37 | - |
|
38 | - /** |
|
39 | - * @var boolean $force_update |
|
40 | - */ |
|
41 | - protected $force_update = false; |
|
42 | - |
|
43 | - /** |
|
44 | - * @var string $capability |
|
45 | - */ |
|
46 | - protected $capability = 'manage_options'; |
|
47 | - |
|
48 | - /** |
|
49 | - * @var string $cap_context |
|
50 | - */ |
|
51 | - protected $cap_context = 'view persistent admin notice'; |
|
52 | - |
|
53 | - /** |
|
54 | - * @var boolean $dismissed |
|
55 | - */ |
|
56 | - protected $dismissed = false; |
|
57 | - |
|
58 | - /** |
|
59 | - * @var CapCheckInterface $cap_check |
|
60 | - */ |
|
61 | - protected $cap_check; |
|
62 | - |
|
63 | - /** |
|
64 | - * if true, then this notice will be deleted from the database |
|
65 | - * |
|
66 | - * @var boolean $purge |
|
67 | - */ |
|
68 | - protected $purge = false; |
|
69 | - |
|
70 | - /** |
|
71 | - * gets set to true if notice is successfully registered with the PersistentAdminNoticeManager |
|
72 | - * if false, and WP_DEBUG is on, then an exception will be thrown in the admin footer |
|
73 | - * |
|
74 | - * @var boolean $registered |
|
75 | - */ |
|
76 | - private $registered = false; |
|
77 | - |
|
78 | - |
|
79 | - /** |
|
80 | - * PersistentAdminNotice constructor |
|
81 | - * |
|
82 | - * @param string $name [required] the name, or key of the Persistent Admin Notice to be stored |
|
83 | - * @param string $message [required] the message to be stored persistently until dismissed |
|
84 | - * @param bool $force_update enforce the reappearance of a persistent message |
|
85 | - * @param string $capability user capability required to view this notice |
|
86 | - * @param string $cap_context description for why the cap check is being performed |
|
87 | - * @param bool $dismissed whether or not the user has already dismissed/viewed this notice |
|
88 | - * @throws InvalidDataTypeException |
|
89 | - */ |
|
90 | - public function __construct( |
|
91 | - $name, |
|
92 | - $message, |
|
93 | - $force_update = false, |
|
94 | - $capability = 'manage_options', |
|
95 | - $cap_context = 'view persistent admin notice', |
|
96 | - $dismissed = false |
|
97 | - ) { |
|
98 | - $this->setName($name); |
|
99 | - $this->setMessage($message); |
|
100 | - $this->setForceUpdate($force_update); |
|
101 | - $this->setCapability($capability); |
|
102 | - $this->setCapContext($cap_context); |
|
103 | - $this->setDismissed($dismissed); |
|
104 | - add_action( |
|
105 | - 'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices', |
|
106 | - array($this, 'registerPersistentAdminNotice') |
|
107 | - ); |
|
108 | - add_action('shutdown', array($this, 'confirmRegistered'), 999); |
|
109 | - } |
|
110 | - |
|
111 | - |
|
112 | - /** |
|
113 | - * @return string |
|
114 | - */ |
|
115 | - public function getName() |
|
116 | - { |
|
117 | - return $this->name; |
|
118 | - } |
|
119 | - |
|
120 | - |
|
121 | - /** |
|
122 | - * @param string $name |
|
123 | - * @throws InvalidDataTypeException |
|
124 | - */ |
|
125 | - private function setName($name) |
|
126 | - { |
|
127 | - if (! is_string($name)) { |
|
128 | - throw new InvalidDataTypeException('$name', $name, 'string'); |
|
129 | - } |
|
130 | - $this->name = sanitize_key($name); |
|
131 | - } |
|
132 | - |
|
133 | - |
|
134 | - /** |
|
135 | - * @return string |
|
136 | - */ |
|
137 | - public function getMessage() |
|
138 | - { |
|
139 | - return $this->message; |
|
140 | - } |
|
141 | - |
|
142 | - |
|
143 | - /** |
|
144 | - * @param string $message |
|
145 | - * @throws InvalidDataTypeException |
|
146 | - */ |
|
147 | - private function setMessage($message) |
|
148 | - { |
|
149 | - if (! is_string($message)) { |
|
150 | - throw new InvalidDataTypeException('$message', $message, 'string'); |
|
151 | - } |
|
152 | - global $allowedtags; |
|
153 | - $allowedtags['br'] = array(); |
|
154 | - $this->message = wp_kses($message, $allowedtags); |
|
155 | - } |
|
156 | - |
|
157 | - |
|
158 | - /** |
|
159 | - * @return bool |
|
160 | - */ |
|
161 | - public function getForceUpdate() |
|
162 | - { |
|
163 | - return $this->force_update; |
|
164 | - } |
|
165 | - |
|
166 | - |
|
167 | - /** |
|
168 | - * @param bool $force_update |
|
169 | - */ |
|
170 | - private function setForceUpdate($force_update) |
|
171 | - { |
|
172 | - $this->force_update = filter_var($force_update, FILTER_VALIDATE_BOOLEAN); |
|
173 | - } |
|
174 | - |
|
175 | - |
|
176 | - /** |
|
177 | - * @return string |
|
178 | - */ |
|
179 | - public function getCapability() |
|
180 | - { |
|
181 | - return $this->capability; |
|
182 | - } |
|
183 | - |
|
184 | - |
|
185 | - /** |
|
186 | - * @param string $capability |
|
187 | - * @throws InvalidDataTypeException |
|
188 | - */ |
|
189 | - private function setCapability($capability) |
|
190 | - { |
|
191 | - if (! is_string($capability)) { |
|
192 | - throw new InvalidDataTypeException('$capability', $capability, 'string'); |
|
193 | - } |
|
194 | - $this->capability = ! empty($capability) ? $capability : 'manage_options'; |
|
195 | - } |
|
196 | - |
|
197 | - |
|
198 | - /** |
|
199 | - * @return string |
|
200 | - */ |
|
201 | - public function getCapContext() |
|
202 | - { |
|
203 | - return $this->cap_context; |
|
204 | - } |
|
205 | - |
|
206 | - |
|
207 | - /** |
|
208 | - * @param string $cap_context |
|
209 | - * @throws InvalidDataTypeException |
|
210 | - */ |
|
211 | - private function setCapContext($cap_context) |
|
212 | - { |
|
213 | - if (! is_string($cap_context)) { |
|
214 | - throw new InvalidDataTypeException('$cap_context', $cap_context, 'string'); |
|
215 | - } |
|
216 | - $this->cap_context = ! empty($cap_context) ? $cap_context : 'view persistent admin notice'; |
|
217 | - } |
|
218 | - |
|
219 | - |
|
220 | - /** |
|
221 | - * @return bool |
|
222 | - */ |
|
223 | - public function getDismissed() |
|
224 | - { |
|
225 | - return $this->dismissed; |
|
226 | - } |
|
227 | - |
|
228 | - |
|
229 | - /** |
|
230 | - * @param bool $dismissed |
|
231 | - */ |
|
232 | - public function setDismissed($dismissed) |
|
233 | - { |
|
234 | - $this->dismissed = filter_var($dismissed, FILTER_VALIDATE_BOOLEAN); |
|
235 | - } |
|
236 | - |
|
237 | - |
|
238 | - /** |
|
239 | - * @return CapCheckInterface |
|
240 | - * @throws InvalidDataTypeException |
|
241 | - */ |
|
242 | - public function getCapCheck() |
|
243 | - { |
|
244 | - if (! $this->cap_check instanceof CapCheckInterface) { |
|
245 | - $this->setCapCheck( |
|
246 | - new CapCheck( |
|
247 | - $this->capability, |
|
248 | - $this->cap_context |
|
249 | - ) |
|
250 | - ); |
|
251 | - } |
|
252 | - return $this->cap_check; |
|
253 | - } |
|
254 | - |
|
255 | - |
|
256 | - /** |
|
257 | - * @param CapCheckInterface $cap_check |
|
258 | - */ |
|
259 | - private function setCapCheck(CapCheckInterface $cap_check) |
|
260 | - { |
|
261 | - $this->cap_check = $cap_check; |
|
262 | - } |
|
263 | - |
|
264 | - |
|
265 | - /** |
|
266 | - * @return bool |
|
267 | - */ |
|
268 | - public function getPurge() |
|
269 | - { |
|
270 | - return $this->purge; |
|
271 | - } |
|
272 | - |
|
273 | - |
|
274 | - /** |
|
275 | - * @param bool $purge |
|
276 | - */ |
|
277 | - public function setPurge($purge) |
|
278 | - { |
|
279 | - $this->purge = filter_var($purge, FILTER_VALIDATE_BOOLEAN); |
|
280 | - } |
|
281 | - |
|
282 | - |
|
283 | - /** |
|
284 | - * given a valid PersistentAdminNotice Collection, |
|
285 | - * this notice will be added if it is not already found in the collection (using its name as the identifier) |
|
286 | - * if an existing notice is found that has already been dismissed, |
|
287 | - * but we are overriding with a forced update, then we will toggle its dismissed state, |
|
288 | - * so that the notice is displayed again |
|
289 | - * |
|
290 | - * @param Collection $persistent_admin_notice_collection |
|
291 | - * @throws InvalidEntityException |
|
292 | - * @throws InvalidDataTypeException |
|
293 | - * @throws DuplicateCollectionIdentifierException |
|
294 | - */ |
|
295 | - public function registerPersistentAdminNotice(Collection $persistent_admin_notice_collection) |
|
296 | - { |
|
297 | - if ($this->registered) { |
|
298 | - return; |
|
299 | - } |
|
300 | - // first check if this notice has already been added to the collection |
|
301 | - if ($persistent_admin_notice_collection->has($this->name)) { |
|
302 | - /** @var PersistentAdminNotice $existing */ |
|
303 | - $existing = $persistent_admin_notice_collection->get($this->name); |
|
304 | - // we don't need to add it again (we can't actually) |
|
305 | - // but if it has already been dismissed, and we are overriding with a forced update |
|
306 | - if ($existing->getDismissed() && $this->getForceUpdate()) { |
|
307 | - // then toggle the notice's dismissed state to true |
|
308 | - // so that it gets displayed again |
|
309 | - $existing->setDismissed(false); |
|
310 | - // and make sure the message is set |
|
311 | - $existing->setMessage($this->message); |
|
312 | - } |
|
313 | - } else { |
|
314 | - $persistent_admin_notice_collection->add($this, $this->name); |
|
315 | - } |
|
316 | - $this->registered = true; |
|
317 | - } |
|
318 | - |
|
319 | - |
|
320 | - /** |
|
321 | - * @throws Exception |
|
322 | - */ |
|
323 | - public function confirmRegistered() |
|
324 | - { |
|
325 | - if (! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) { |
|
326 | - PersistentAdminNoticeManager::loadRegisterAndSaveNotices(); |
|
327 | - } |
|
328 | - if (! $this->registered && WP_DEBUG) { |
|
329 | - throw new DomainException( |
|
330 | - sprintf( |
|
331 | - esc_html__( |
|
332 | - 'The "%1$s" PersistentAdminNotice was not successfully registered. Please ensure that it is being created prior to either the "admin_notices" or "network_admin_notices" hooks being triggered.', |
|
333 | - 'event_espresso' |
|
334 | - ), |
|
335 | - $this->name |
|
336 | - ) |
|
337 | - ); |
|
338 | - } |
|
339 | - } |
|
28 | + /** |
|
29 | + * @var string $name |
|
30 | + */ |
|
31 | + protected $name = ''; |
|
32 | + |
|
33 | + /** |
|
34 | + * @var string $message |
|
35 | + */ |
|
36 | + protected $message = ''; |
|
37 | + |
|
38 | + /** |
|
39 | + * @var boolean $force_update |
|
40 | + */ |
|
41 | + protected $force_update = false; |
|
42 | + |
|
43 | + /** |
|
44 | + * @var string $capability |
|
45 | + */ |
|
46 | + protected $capability = 'manage_options'; |
|
47 | + |
|
48 | + /** |
|
49 | + * @var string $cap_context |
|
50 | + */ |
|
51 | + protected $cap_context = 'view persistent admin notice'; |
|
52 | + |
|
53 | + /** |
|
54 | + * @var boolean $dismissed |
|
55 | + */ |
|
56 | + protected $dismissed = false; |
|
57 | + |
|
58 | + /** |
|
59 | + * @var CapCheckInterface $cap_check |
|
60 | + */ |
|
61 | + protected $cap_check; |
|
62 | + |
|
63 | + /** |
|
64 | + * if true, then this notice will be deleted from the database |
|
65 | + * |
|
66 | + * @var boolean $purge |
|
67 | + */ |
|
68 | + protected $purge = false; |
|
69 | + |
|
70 | + /** |
|
71 | + * gets set to true if notice is successfully registered with the PersistentAdminNoticeManager |
|
72 | + * if false, and WP_DEBUG is on, then an exception will be thrown in the admin footer |
|
73 | + * |
|
74 | + * @var boolean $registered |
|
75 | + */ |
|
76 | + private $registered = false; |
|
77 | + |
|
78 | + |
|
79 | + /** |
|
80 | + * PersistentAdminNotice constructor |
|
81 | + * |
|
82 | + * @param string $name [required] the name, or key of the Persistent Admin Notice to be stored |
|
83 | + * @param string $message [required] the message to be stored persistently until dismissed |
|
84 | + * @param bool $force_update enforce the reappearance of a persistent message |
|
85 | + * @param string $capability user capability required to view this notice |
|
86 | + * @param string $cap_context description for why the cap check is being performed |
|
87 | + * @param bool $dismissed whether or not the user has already dismissed/viewed this notice |
|
88 | + * @throws InvalidDataTypeException |
|
89 | + */ |
|
90 | + public function __construct( |
|
91 | + $name, |
|
92 | + $message, |
|
93 | + $force_update = false, |
|
94 | + $capability = 'manage_options', |
|
95 | + $cap_context = 'view persistent admin notice', |
|
96 | + $dismissed = false |
|
97 | + ) { |
|
98 | + $this->setName($name); |
|
99 | + $this->setMessage($message); |
|
100 | + $this->setForceUpdate($force_update); |
|
101 | + $this->setCapability($capability); |
|
102 | + $this->setCapContext($cap_context); |
|
103 | + $this->setDismissed($dismissed); |
|
104 | + add_action( |
|
105 | + 'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices', |
|
106 | + array($this, 'registerPersistentAdminNotice') |
|
107 | + ); |
|
108 | + add_action('shutdown', array($this, 'confirmRegistered'), 999); |
|
109 | + } |
|
110 | + |
|
111 | + |
|
112 | + /** |
|
113 | + * @return string |
|
114 | + */ |
|
115 | + public function getName() |
|
116 | + { |
|
117 | + return $this->name; |
|
118 | + } |
|
119 | + |
|
120 | + |
|
121 | + /** |
|
122 | + * @param string $name |
|
123 | + * @throws InvalidDataTypeException |
|
124 | + */ |
|
125 | + private function setName($name) |
|
126 | + { |
|
127 | + if (! is_string($name)) { |
|
128 | + throw new InvalidDataTypeException('$name', $name, 'string'); |
|
129 | + } |
|
130 | + $this->name = sanitize_key($name); |
|
131 | + } |
|
132 | + |
|
133 | + |
|
134 | + /** |
|
135 | + * @return string |
|
136 | + */ |
|
137 | + public function getMessage() |
|
138 | + { |
|
139 | + return $this->message; |
|
140 | + } |
|
141 | + |
|
142 | + |
|
143 | + /** |
|
144 | + * @param string $message |
|
145 | + * @throws InvalidDataTypeException |
|
146 | + */ |
|
147 | + private function setMessage($message) |
|
148 | + { |
|
149 | + if (! is_string($message)) { |
|
150 | + throw new InvalidDataTypeException('$message', $message, 'string'); |
|
151 | + } |
|
152 | + global $allowedtags; |
|
153 | + $allowedtags['br'] = array(); |
|
154 | + $this->message = wp_kses($message, $allowedtags); |
|
155 | + } |
|
156 | + |
|
157 | + |
|
158 | + /** |
|
159 | + * @return bool |
|
160 | + */ |
|
161 | + public function getForceUpdate() |
|
162 | + { |
|
163 | + return $this->force_update; |
|
164 | + } |
|
165 | + |
|
166 | + |
|
167 | + /** |
|
168 | + * @param bool $force_update |
|
169 | + */ |
|
170 | + private function setForceUpdate($force_update) |
|
171 | + { |
|
172 | + $this->force_update = filter_var($force_update, FILTER_VALIDATE_BOOLEAN); |
|
173 | + } |
|
174 | + |
|
175 | + |
|
176 | + /** |
|
177 | + * @return string |
|
178 | + */ |
|
179 | + public function getCapability() |
|
180 | + { |
|
181 | + return $this->capability; |
|
182 | + } |
|
183 | + |
|
184 | + |
|
185 | + /** |
|
186 | + * @param string $capability |
|
187 | + * @throws InvalidDataTypeException |
|
188 | + */ |
|
189 | + private function setCapability($capability) |
|
190 | + { |
|
191 | + if (! is_string($capability)) { |
|
192 | + throw new InvalidDataTypeException('$capability', $capability, 'string'); |
|
193 | + } |
|
194 | + $this->capability = ! empty($capability) ? $capability : 'manage_options'; |
|
195 | + } |
|
196 | + |
|
197 | + |
|
198 | + /** |
|
199 | + * @return string |
|
200 | + */ |
|
201 | + public function getCapContext() |
|
202 | + { |
|
203 | + return $this->cap_context; |
|
204 | + } |
|
205 | + |
|
206 | + |
|
207 | + /** |
|
208 | + * @param string $cap_context |
|
209 | + * @throws InvalidDataTypeException |
|
210 | + */ |
|
211 | + private function setCapContext($cap_context) |
|
212 | + { |
|
213 | + if (! is_string($cap_context)) { |
|
214 | + throw new InvalidDataTypeException('$cap_context', $cap_context, 'string'); |
|
215 | + } |
|
216 | + $this->cap_context = ! empty($cap_context) ? $cap_context : 'view persistent admin notice'; |
|
217 | + } |
|
218 | + |
|
219 | + |
|
220 | + /** |
|
221 | + * @return bool |
|
222 | + */ |
|
223 | + public function getDismissed() |
|
224 | + { |
|
225 | + return $this->dismissed; |
|
226 | + } |
|
227 | + |
|
228 | + |
|
229 | + /** |
|
230 | + * @param bool $dismissed |
|
231 | + */ |
|
232 | + public function setDismissed($dismissed) |
|
233 | + { |
|
234 | + $this->dismissed = filter_var($dismissed, FILTER_VALIDATE_BOOLEAN); |
|
235 | + } |
|
236 | + |
|
237 | + |
|
238 | + /** |
|
239 | + * @return CapCheckInterface |
|
240 | + * @throws InvalidDataTypeException |
|
241 | + */ |
|
242 | + public function getCapCheck() |
|
243 | + { |
|
244 | + if (! $this->cap_check instanceof CapCheckInterface) { |
|
245 | + $this->setCapCheck( |
|
246 | + new CapCheck( |
|
247 | + $this->capability, |
|
248 | + $this->cap_context |
|
249 | + ) |
|
250 | + ); |
|
251 | + } |
|
252 | + return $this->cap_check; |
|
253 | + } |
|
254 | + |
|
255 | + |
|
256 | + /** |
|
257 | + * @param CapCheckInterface $cap_check |
|
258 | + */ |
|
259 | + private function setCapCheck(CapCheckInterface $cap_check) |
|
260 | + { |
|
261 | + $this->cap_check = $cap_check; |
|
262 | + } |
|
263 | + |
|
264 | + |
|
265 | + /** |
|
266 | + * @return bool |
|
267 | + */ |
|
268 | + public function getPurge() |
|
269 | + { |
|
270 | + return $this->purge; |
|
271 | + } |
|
272 | + |
|
273 | + |
|
274 | + /** |
|
275 | + * @param bool $purge |
|
276 | + */ |
|
277 | + public function setPurge($purge) |
|
278 | + { |
|
279 | + $this->purge = filter_var($purge, FILTER_VALIDATE_BOOLEAN); |
|
280 | + } |
|
281 | + |
|
282 | + |
|
283 | + /** |
|
284 | + * given a valid PersistentAdminNotice Collection, |
|
285 | + * this notice will be added if it is not already found in the collection (using its name as the identifier) |
|
286 | + * if an existing notice is found that has already been dismissed, |
|
287 | + * but we are overriding with a forced update, then we will toggle its dismissed state, |
|
288 | + * so that the notice is displayed again |
|
289 | + * |
|
290 | + * @param Collection $persistent_admin_notice_collection |
|
291 | + * @throws InvalidEntityException |
|
292 | + * @throws InvalidDataTypeException |
|
293 | + * @throws DuplicateCollectionIdentifierException |
|
294 | + */ |
|
295 | + public function registerPersistentAdminNotice(Collection $persistent_admin_notice_collection) |
|
296 | + { |
|
297 | + if ($this->registered) { |
|
298 | + return; |
|
299 | + } |
|
300 | + // first check if this notice has already been added to the collection |
|
301 | + if ($persistent_admin_notice_collection->has($this->name)) { |
|
302 | + /** @var PersistentAdminNotice $existing */ |
|
303 | + $existing = $persistent_admin_notice_collection->get($this->name); |
|
304 | + // we don't need to add it again (we can't actually) |
|
305 | + // but if it has already been dismissed, and we are overriding with a forced update |
|
306 | + if ($existing->getDismissed() && $this->getForceUpdate()) { |
|
307 | + // then toggle the notice's dismissed state to true |
|
308 | + // so that it gets displayed again |
|
309 | + $existing->setDismissed(false); |
|
310 | + // and make sure the message is set |
|
311 | + $existing->setMessage($this->message); |
|
312 | + } |
|
313 | + } else { |
|
314 | + $persistent_admin_notice_collection->add($this, $this->name); |
|
315 | + } |
|
316 | + $this->registered = true; |
|
317 | + } |
|
318 | + |
|
319 | + |
|
320 | + /** |
|
321 | + * @throws Exception |
|
322 | + */ |
|
323 | + public function confirmRegistered() |
|
324 | + { |
|
325 | + if (! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) { |
|
326 | + PersistentAdminNoticeManager::loadRegisterAndSaveNotices(); |
|
327 | + } |
|
328 | + if (! $this->registered && WP_DEBUG) { |
|
329 | + throw new DomainException( |
|
330 | + sprintf( |
|
331 | + esc_html__( |
|
332 | + 'The "%1$s" PersistentAdminNotice was not successfully registered. Please ensure that it is being created prior to either the "admin_notices" or "network_admin_notices" hooks being triggered.', |
|
333 | + 'event_espresso' |
|
334 | + ), |
|
335 | + $this->name |
|
336 | + ) |
|
337 | + ); |
|
338 | + } |
|
339 | + } |
|
340 | 340 | } |
@@ -14,28 +14,28 @@ |
||
14 | 14 | class EE_Detect_File_Editor_Request extends EE_Middleware |
15 | 15 | { |
16 | 16 | |
17 | - /** |
|
18 | - * @deprecated |
|
19 | - * @param EE_Request $request |
|
20 | - * @param EE_Response $response |
|
21 | - * @return EE_Response |
|
22 | - */ |
|
23 | - public function handle_request(EE_Request $request, EE_Response $response) |
|
24 | - { |
|
25 | - EE_Error::doing_it_wrong( |
|
26 | - __METHOD__, |
|
27 | - sprintf( |
|
28 | - esc_html__( |
|
29 | - 'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace', |
|
30 | - 'event_espresso' |
|
31 | - ), |
|
32 | - 'EventEspresso\core\services\request\middleware\DetectFileEditorRequest', |
|
33 | - '\core\services\request', |
|
34 | - 'EventEspresso\core\services\request' |
|
35 | - ), |
|
36 | - '4.9.52' |
|
37 | - ); |
|
38 | - return $response; |
|
39 | - } |
|
17 | + /** |
|
18 | + * @deprecated |
|
19 | + * @param EE_Request $request |
|
20 | + * @param EE_Response $response |
|
21 | + * @return EE_Response |
|
22 | + */ |
|
23 | + public function handle_request(EE_Request $request, EE_Response $response) |
|
24 | + { |
|
25 | + EE_Error::doing_it_wrong( |
|
26 | + __METHOD__, |
|
27 | + sprintf( |
|
28 | + esc_html__( |
|
29 | + 'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace', |
|
30 | + 'event_espresso' |
|
31 | + ), |
|
32 | + 'EventEspresso\core\services\request\middleware\DetectFileEditorRequest', |
|
33 | + '\core\services\request', |
|
34 | + 'EventEspresso\core\services\request' |
|
35 | + ), |
|
36 | + '4.9.52' |
|
37 | + ); |
|
38 | + return $response; |
|
39 | + } |
|
40 | 40 | |
41 | 41 | } |
@@ -78,13 +78,13 @@ |
||
78 | 78 | // EE_Dependency_Map: info about how to load classes required by other classes |
79 | 79 | espresso_load_required( |
80 | 80 | 'EE_Dependency_Map', |
81 | - EE_CORE . 'EE_Dependency_Map.core.php' |
|
81 | + EE_CORE.'EE_Dependency_Map.core.php' |
|
82 | 82 | ); |
83 | 83 | $this->dependency_map = EE_Dependency_Map::instance($this->class_cache); |
84 | 84 | // EE_Registry: central repository for classes (legacy) |
85 | 85 | espresso_load_required( |
86 | 86 | 'EE_Registry', |
87 | - EE_CORE . 'EE_Registry.core.php' |
|
87 | + EE_CORE.'EE_Registry.core.php' |
|
88 | 88 | ); |
89 | 89 | $this->registry = EE_Registry::instance( |
90 | 90 | $this->dependency_map, |
@@ -25,123 +25,123 @@ |
||
25 | 25 | class BootstrapDependencyInjectionContainer |
26 | 26 | { |
27 | 27 | |
28 | - /** |
|
29 | - * @var EE_Dependency_Map $dependency_map |
|
30 | - */ |
|
31 | - protected $dependency_map; |
|
32 | - |
|
33 | - /** |
|
34 | - * @type LoaderInterface $loader |
|
35 | - */ |
|
36 | - protected $loader; |
|
37 | - |
|
38 | - /** |
|
39 | - * @var EE_Registry $registry |
|
40 | - */ |
|
41 | - protected $registry; |
|
42 | - |
|
43 | - /** |
|
44 | - * @var ClassInterfaceCache $class_cache |
|
45 | - */ |
|
46 | - private $class_cache; |
|
47 | - |
|
48 | - /** |
|
49 | - * @var Mirror |
|
50 | - */ |
|
51 | - private $mirror; |
|
52 | - |
|
53 | - /** |
|
54 | - * @var ObjectIdentifier |
|
55 | - */ |
|
56 | - private $object_identifier; |
|
57 | - |
|
58 | - |
|
59 | - /** |
|
60 | - * Can't use this just yet until we exorcise some more of our singleton usage from core |
|
61 | - */ |
|
62 | - public function buildDependencyInjectionContainer() |
|
63 | - { |
|
64 | - // build DI container |
|
65 | - // $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop(); |
|
66 | - // $OpenCoffeeShop->addRecipes(); |
|
67 | - // $CoffeeShop = $OpenCoffeeShop->CoffeeShop(); |
|
68 | - } |
|
69 | - |
|
70 | - |
|
71 | - /** |
|
72 | - * Setups EE_Registry and EE_Dependency_Map |
|
73 | - * |
|
74 | - * @throws EE_Error |
|
75 | - */ |
|
76 | - public function buildLegacyDependencyInjectionContainer() |
|
77 | - { |
|
78 | - $this->class_cache = new ClassInterfaceCache(); |
|
79 | - $this->object_identifier = new ObjectIdentifier($this->class_cache); |
|
80 | - $this->mirror = new Mirror(); |
|
81 | - // EE_Dependency_Map: info about how to load classes required by other classes |
|
82 | - espresso_load_required( |
|
83 | - 'EE_Dependency_Map', |
|
84 | - EE_CORE . 'EE_Dependency_Map.core.php' |
|
85 | - ); |
|
86 | - $this->dependency_map = EE_Dependency_Map::instance($this->class_cache); |
|
87 | - // EE_Registry: central repository for classes (legacy) |
|
88 | - espresso_load_required( |
|
89 | - 'EE_Registry', |
|
90 | - EE_CORE . 'EE_Registry.core.php' |
|
91 | - ); |
|
92 | - $this->registry = EE_Registry::instance( |
|
93 | - $this->dependency_map, |
|
94 | - $this->mirror, |
|
95 | - $this->class_cache, |
|
96 | - $this->object_identifier |
|
97 | - ); |
|
98 | - } |
|
99 | - |
|
100 | - |
|
101 | - /** |
|
102 | - * Performs initial setup for the generic Loader |
|
103 | - * |
|
104 | - * @throws InvalidDataTypeException |
|
105 | - * @throws InvalidInterfaceException |
|
106 | - * @throws InvalidArgumentException |
|
107 | - */ |
|
108 | - public function buildLoader() |
|
109 | - { |
|
110 | - $this->loader = LoaderFactory::getLoader( |
|
111 | - $this->registry, |
|
112 | - $this->class_cache, |
|
113 | - $this->object_identifier |
|
114 | - ); |
|
115 | - $this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache); |
|
116 | - $this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier); |
|
117 | - $this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror); |
|
118 | - $this->dependency_map->setLoader($this->loader); |
|
119 | - } |
|
120 | - |
|
121 | - |
|
122 | - /** |
|
123 | - * @return EE_Dependency_Map |
|
124 | - */ |
|
125 | - public function getDependencyMap() |
|
126 | - { |
|
127 | - return $this->dependency_map; |
|
128 | - } |
|
129 | - |
|
130 | - |
|
131 | - /** |
|
132 | - * @return EE_Registry |
|
133 | - */ |
|
134 | - public function getRegistry() |
|
135 | - { |
|
136 | - return $this->registry; |
|
137 | - } |
|
138 | - |
|
139 | - |
|
140 | - /** |
|
141 | - * @return LoaderInterface |
|
142 | - */ |
|
143 | - public function getLoader() |
|
144 | - { |
|
145 | - return $this->loader; |
|
146 | - } |
|
28 | + /** |
|
29 | + * @var EE_Dependency_Map $dependency_map |
|
30 | + */ |
|
31 | + protected $dependency_map; |
|
32 | + |
|
33 | + /** |
|
34 | + * @type LoaderInterface $loader |
|
35 | + */ |
|
36 | + protected $loader; |
|
37 | + |
|
38 | + /** |
|
39 | + * @var EE_Registry $registry |
|
40 | + */ |
|
41 | + protected $registry; |
|
42 | + |
|
43 | + /** |
|
44 | + * @var ClassInterfaceCache $class_cache |
|
45 | + */ |
|
46 | + private $class_cache; |
|
47 | + |
|
48 | + /** |
|
49 | + * @var Mirror |
|
50 | + */ |
|
51 | + private $mirror; |
|
52 | + |
|
53 | + /** |
|
54 | + * @var ObjectIdentifier |
|
55 | + */ |
|
56 | + private $object_identifier; |
|
57 | + |
|
58 | + |
|
59 | + /** |
|
60 | + * Can't use this just yet until we exorcise some more of our singleton usage from core |
|
61 | + */ |
|
62 | + public function buildDependencyInjectionContainer() |
|
63 | + { |
|
64 | + // build DI container |
|
65 | + // $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop(); |
|
66 | + // $OpenCoffeeShop->addRecipes(); |
|
67 | + // $CoffeeShop = $OpenCoffeeShop->CoffeeShop(); |
|
68 | + } |
|
69 | + |
|
70 | + |
|
71 | + /** |
|
72 | + * Setups EE_Registry and EE_Dependency_Map |
|
73 | + * |
|
74 | + * @throws EE_Error |
|
75 | + */ |
|
76 | + public function buildLegacyDependencyInjectionContainer() |
|
77 | + { |
|
78 | + $this->class_cache = new ClassInterfaceCache(); |
|
79 | + $this->object_identifier = new ObjectIdentifier($this->class_cache); |
|
80 | + $this->mirror = new Mirror(); |
|
81 | + // EE_Dependency_Map: info about how to load classes required by other classes |
|
82 | + espresso_load_required( |
|
83 | + 'EE_Dependency_Map', |
|
84 | + EE_CORE . 'EE_Dependency_Map.core.php' |
|
85 | + ); |
|
86 | + $this->dependency_map = EE_Dependency_Map::instance($this->class_cache); |
|
87 | + // EE_Registry: central repository for classes (legacy) |
|
88 | + espresso_load_required( |
|
89 | + 'EE_Registry', |
|
90 | + EE_CORE . 'EE_Registry.core.php' |
|
91 | + ); |
|
92 | + $this->registry = EE_Registry::instance( |
|
93 | + $this->dependency_map, |
|
94 | + $this->mirror, |
|
95 | + $this->class_cache, |
|
96 | + $this->object_identifier |
|
97 | + ); |
|
98 | + } |
|
99 | + |
|
100 | + |
|
101 | + /** |
|
102 | + * Performs initial setup for the generic Loader |
|
103 | + * |
|
104 | + * @throws InvalidDataTypeException |
|
105 | + * @throws InvalidInterfaceException |
|
106 | + * @throws InvalidArgumentException |
|
107 | + */ |
|
108 | + public function buildLoader() |
|
109 | + { |
|
110 | + $this->loader = LoaderFactory::getLoader( |
|
111 | + $this->registry, |
|
112 | + $this->class_cache, |
|
113 | + $this->object_identifier |
|
114 | + ); |
|
115 | + $this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache); |
|
116 | + $this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier); |
|
117 | + $this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror); |
|
118 | + $this->dependency_map->setLoader($this->loader); |
|
119 | + } |
|
120 | + |
|
121 | + |
|
122 | + /** |
|
123 | + * @return EE_Dependency_Map |
|
124 | + */ |
|
125 | + public function getDependencyMap() |
|
126 | + { |
|
127 | + return $this->dependency_map; |
|
128 | + } |
|
129 | + |
|
130 | + |
|
131 | + /** |
|
132 | + * @return EE_Registry |
|
133 | + */ |
|
134 | + public function getRegistry() |
|
135 | + { |
|
136 | + return $this->registry; |
|
137 | + } |
|
138 | + |
|
139 | + |
|
140 | + /** |
|
141 | + * @return LoaderInterface |
|
142 | + */ |
|
143 | + public function getLoader() |
|
144 | + { |
|
145 | + return $this->loader; |
|
146 | + } |
|
147 | 147 | } |
@@ -65,7 +65,7 @@ |
||
65 | 65 | */ |
66 | 66 | public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array()) |
67 | 67 | { |
68 | - $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm( |
|
68 | + $this->custom_taxonomy_terms[][$term_slug] = new CustomTaxonomyTerm( |
|
69 | 69 | $taxonomy, |
70 | 70 | $term_slug, |
71 | 71 | $cpt_slugs |
@@ -16,181 +16,181 @@ |
||
16 | 16 | class RegisterCustomTaxonomyTerms |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * @var array[] $custom_taxonomy_terms |
|
21 | - */ |
|
22 | - public $custom_taxonomy_terms = array(); |
|
23 | - |
|
24 | - |
|
25 | - /** |
|
26 | - * RegisterCustomTaxonomyTerms constructor. |
|
27 | - */ |
|
28 | - public function __construct() |
|
29 | - { |
|
30 | - // hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts |
|
31 | - // IF they don't have a term for that taxonomy set. |
|
32 | - add_action('save_post', array($this, 'saveDefaultTerm'), 100, 2); |
|
33 | - do_action( |
|
34 | - 'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end', |
|
35 | - $this |
|
36 | - ); |
|
37 | - } |
|
38 | - |
|
39 | - |
|
40 | - public function registerCustomTaxonomyTerms() |
|
41 | - { |
|
42 | - // setup default terms in any of our taxonomies (but only if we're in admin). |
|
43 | - // Why not added via register_activation_hook? |
|
44 | - // Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies |
|
45 | - // (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin. |
|
46 | - // Keep in mind that this will READ these terms if they are deleted by the user. Hence MUST use terms. |
|
47 | - // if ( is_admin() ) { |
|
48 | - // $this->set_must_use_event_types(); |
|
49 | - // } |
|
50 | - // set default terms |
|
51 | - $this->registerCustomTaxonomyTerm( |
|
52 | - 'espresso_event_type', |
|
53 | - 'single-event', |
|
54 | - array('espresso_events') |
|
55 | - ); |
|
56 | - } |
|
57 | - |
|
58 | - |
|
59 | - /** |
|
60 | - * Allows us to set what the default will be for terms when a cpt is PUBLISHED. |
|
61 | - * |
|
62 | - * @param string $taxonomy The taxonomy we're using for the default term |
|
63 | - * @param string $term_slug The slug of the term that will be the default. |
|
64 | - * @param array $cpt_slugs An array of custom post types we want the default assigned to |
|
65 | - */ |
|
66 | - public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array()) |
|
67 | - { |
|
68 | - $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm( |
|
69 | - $taxonomy, |
|
70 | - $term_slug, |
|
71 | - $cpt_slugs |
|
72 | - ); |
|
73 | - } |
|
74 | - |
|
75 | - |
|
76 | - /** |
|
77 | - * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property |
|
78 | - * |
|
79 | - * @param int $post_id ID of CPT being saved |
|
80 | - * @param WP_Post $post Post object |
|
81 | - * @return void |
|
82 | - */ |
|
83 | - public function saveDefaultTerm($post_id, WP_Post $post) |
|
84 | - { |
|
85 | - if (empty($this->custom_taxonomy_terms)) { |
|
86 | - return; |
|
87 | - } |
|
88 | - // no default terms set so lets just exit. |
|
89 | - foreach ($this->custom_taxonomy_terms as $custom_taxonomy_terms) { |
|
90 | - foreach ($custom_taxonomy_terms as $custom_taxonomy_term) { |
|
91 | - if ( |
|
92 | - $post->post_status === 'publish' |
|
93 | - && $custom_taxonomy_term instanceof CustomTaxonomyTerm |
|
94 | - && in_array($post->post_type, $custom_taxonomy_term->customPostTypeSlugs(), true) |
|
95 | - ) { |
|
96 | - // note some error proofing going on here to save unnecessary db queries |
|
97 | - $taxonomies = get_object_taxonomies($post->post_type); |
|
98 | - foreach ($taxonomies as $taxonomy) { |
|
99 | - $terms = wp_get_post_terms($post_id, $taxonomy); |
|
100 | - if (empty($terms) && $taxonomy === $custom_taxonomy_term->taxonomySlug()) { |
|
101 | - wp_set_object_terms( |
|
102 | - $post_id, |
|
103 | - array($custom_taxonomy_term->termSlug()), |
|
104 | - $taxonomy |
|
105 | - ); |
|
106 | - } |
|
107 | - } |
|
108 | - } |
|
109 | - } |
|
110 | - } |
|
111 | - } |
|
112 | - |
|
113 | - |
|
114 | - /** |
|
115 | - * @return void |
|
116 | - */ |
|
117 | - public function setMustUseEventTypes() |
|
118 | - { |
|
119 | - $term_details = array( |
|
120 | - // Attendee's register for the first date-time only |
|
121 | - 'single-event' => array( |
|
122 | - 'term' => esc_html__('Single Event', 'event_espresso'), |
|
123 | - 'desc' => esc_html__( |
|
124 | - 'A single event that spans one or more consecutive days.', |
|
125 | - 'event_espresso' |
|
126 | - ), |
|
127 | - ), |
|
128 | - // example: a party or two-day long workshop |
|
129 | - // Attendee's can register for any of the date-times |
|
130 | - 'multi-event' => array( |
|
131 | - 'term' => esc_html__('Multi Event', 'event_espresso'), |
|
132 | - 'desc' => esc_html__( |
|
133 | - 'Multiple, separate, but related events that occur on consecutive days.', |
|
134 | - 'event_espresso' |
|
135 | - ), |
|
136 | - ), |
|
137 | - // example: a three day music festival or week long conference |
|
138 | - // Attendee's register for the first date-time only |
|
139 | - 'event-series' => array( |
|
140 | - 'term' => esc_html__('Event Series', 'event_espresso'), |
|
141 | - 'desc' => esc_html__( |
|
142 | - ' Multiple events that occur over multiple non-consecutive days.', |
|
143 | - 'event_espresso' |
|
144 | - ), |
|
145 | - ), |
|
146 | - // example: an 8 week introduction to basket weaving course |
|
147 | - // Attendee's can register for any of the date-times. |
|
148 | - 'recurring-event' => array( |
|
149 | - 'term' => esc_html__('Recurring Event', 'event_espresso'), |
|
150 | - 'desc' => esc_html__( |
|
151 | - 'Multiple events that occur over multiple non-consecutive days.', |
|
152 | - 'event_espresso' |
|
153 | - ), |
|
154 | - ), |
|
155 | - // example: a yoga class |
|
156 | - 'ongoing' => array( |
|
157 | - 'term' => esc_html__('Ongoing Event', 'event_espresso'), |
|
158 | - 'desc' => esc_html__( |
|
159 | - 'An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event', |
|
160 | - 'event_espresso' |
|
161 | - ), |
|
162 | - ) |
|
163 | - // example: access to a museum |
|
164 | - // 'walk-in' => array( esc_html__('Walk In', 'event_espresso'), esc_html__('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ), |
|
165 | - // 'reservation' => array( esc_html__('Reservation', 'event_espresso'), esc_html__('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1 |
|
166 | - // 'multiple-session' => array( esc_html__('Multiple Session', 'event_espresso'), esc_html__('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1 |
|
167 | - // 'appointment' => array( esc_html__('Appointments', 'event_espresso'), esc_html__('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') ) |
|
168 | - ); |
|
169 | - $this->setMustUseTerms('espresso_event_type', $term_details); |
|
170 | - } |
|
171 | - |
|
172 | - |
|
173 | - /** |
|
174 | - * wrapper method for handling the setting up of initial terms in the db (if they don't already exist). |
|
175 | - * Note this should ONLY be used for terms that always must be present. Be aware that if an initial term is |
|
176 | - * deleted then it WILL be recreated. |
|
177 | - * |
|
178 | - * @param string $taxonomy The name of the taxonomy |
|
179 | - * @param array $term_details An array of term details indexed by slug and containing Name of term, and |
|
180 | - * description as the elements in the array |
|
181 | - * @return void |
|
182 | - */ |
|
183 | - public function setMustUseTerms($taxonomy, $term_details) |
|
184 | - { |
|
185 | - $term_details = (array) $term_details; |
|
186 | - foreach ($term_details as $slug => $details) { |
|
187 | - if (isset($details['term'], $details['desc']) && ! term_exists($slug, $taxonomy)) { |
|
188 | - $insert_arr = array( |
|
189 | - 'slug' => $slug, |
|
190 | - 'description' => $details['desc'], |
|
191 | - ); |
|
192 | - wp_insert_term($details['term'], $taxonomy, $insert_arr); |
|
193 | - } |
|
194 | - } |
|
195 | - } |
|
19 | + /** |
|
20 | + * @var array[] $custom_taxonomy_terms |
|
21 | + */ |
|
22 | + public $custom_taxonomy_terms = array(); |
|
23 | + |
|
24 | + |
|
25 | + /** |
|
26 | + * RegisterCustomTaxonomyTerms constructor. |
|
27 | + */ |
|
28 | + public function __construct() |
|
29 | + { |
|
30 | + // hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts |
|
31 | + // IF they don't have a term for that taxonomy set. |
|
32 | + add_action('save_post', array($this, 'saveDefaultTerm'), 100, 2); |
|
33 | + do_action( |
|
34 | + 'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end', |
|
35 | + $this |
|
36 | + ); |
|
37 | + } |
|
38 | + |
|
39 | + |
|
40 | + public function registerCustomTaxonomyTerms() |
|
41 | + { |
|
42 | + // setup default terms in any of our taxonomies (but only if we're in admin). |
|
43 | + // Why not added via register_activation_hook? |
|
44 | + // Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies |
|
45 | + // (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin. |
|
46 | + // Keep in mind that this will READ these terms if they are deleted by the user. Hence MUST use terms. |
|
47 | + // if ( is_admin() ) { |
|
48 | + // $this->set_must_use_event_types(); |
|
49 | + // } |
|
50 | + // set default terms |
|
51 | + $this->registerCustomTaxonomyTerm( |
|
52 | + 'espresso_event_type', |
|
53 | + 'single-event', |
|
54 | + array('espresso_events') |
|
55 | + ); |
|
56 | + } |
|
57 | + |
|
58 | + |
|
59 | + /** |
|
60 | + * Allows us to set what the default will be for terms when a cpt is PUBLISHED. |
|
61 | + * |
|
62 | + * @param string $taxonomy The taxonomy we're using for the default term |
|
63 | + * @param string $term_slug The slug of the term that will be the default. |
|
64 | + * @param array $cpt_slugs An array of custom post types we want the default assigned to |
|
65 | + */ |
|
66 | + public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array()) |
|
67 | + { |
|
68 | + $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm( |
|
69 | + $taxonomy, |
|
70 | + $term_slug, |
|
71 | + $cpt_slugs |
|
72 | + ); |
|
73 | + } |
|
74 | + |
|
75 | + |
|
76 | + /** |
|
77 | + * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property |
|
78 | + * |
|
79 | + * @param int $post_id ID of CPT being saved |
|
80 | + * @param WP_Post $post Post object |
|
81 | + * @return void |
|
82 | + */ |
|
83 | + public function saveDefaultTerm($post_id, WP_Post $post) |
|
84 | + { |
|
85 | + if (empty($this->custom_taxonomy_terms)) { |
|
86 | + return; |
|
87 | + } |
|
88 | + // no default terms set so lets just exit. |
|
89 | + foreach ($this->custom_taxonomy_terms as $custom_taxonomy_terms) { |
|
90 | + foreach ($custom_taxonomy_terms as $custom_taxonomy_term) { |
|
91 | + if ( |
|
92 | + $post->post_status === 'publish' |
|
93 | + && $custom_taxonomy_term instanceof CustomTaxonomyTerm |
|
94 | + && in_array($post->post_type, $custom_taxonomy_term->customPostTypeSlugs(), true) |
|
95 | + ) { |
|
96 | + // note some error proofing going on here to save unnecessary db queries |
|
97 | + $taxonomies = get_object_taxonomies($post->post_type); |
|
98 | + foreach ($taxonomies as $taxonomy) { |
|
99 | + $terms = wp_get_post_terms($post_id, $taxonomy); |
|
100 | + if (empty($terms) && $taxonomy === $custom_taxonomy_term->taxonomySlug()) { |
|
101 | + wp_set_object_terms( |
|
102 | + $post_id, |
|
103 | + array($custom_taxonomy_term->termSlug()), |
|
104 | + $taxonomy |
|
105 | + ); |
|
106 | + } |
|
107 | + } |
|
108 | + } |
|
109 | + } |
|
110 | + } |
|
111 | + } |
|
112 | + |
|
113 | + |
|
114 | + /** |
|
115 | + * @return void |
|
116 | + */ |
|
117 | + public function setMustUseEventTypes() |
|
118 | + { |
|
119 | + $term_details = array( |
|
120 | + // Attendee's register for the first date-time only |
|
121 | + 'single-event' => array( |
|
122 | + 'term' => esc_html__('Single Event', 'event_espresso'), |
|
123 | + 'desc' => esc_html__( |
|
124 | + 'A single event that spans one or more consecutive days.', |
|
125 | + 'event_espresso' |
|
126 | + ), |
|
127 | + ), |
|
128 | + // example: a party or two-day long workshop |
|
129 | + // Attendee's can register for any of the date-times |
|
130 | + 'multi-event' => array( |
|
131 | + 'term' => esc_html__('Multi Event', 'event_espresso'), |
|
132 | + 'desc' => esc_html__( |
|
133 | + 'Multiple, separate, but related events that occur on consecutive days.', |
|
134 | + 'event_espresso' |
|
135 | + ), |
|
136 | + ), |
|
137 | + // example: a three day music festival or week long conference |
|
138 | + // Attendee's register for the first date-time only |
|
139 | + 'event-series' => array( |
|
140 | + 'term' => esc_html__('Event Series', 'event_espresso'), |
|
141 | + 'desc' => esc_html__( |
|
142 | + ' Multiple events that occur over multiple non-consecutive days.', |
|
143 | + 'event_espresso' |
|
144 | + ), |
|
145 | + ), |
|
146 | + // example: an 8 week introduction to basket weaving course |
|
147 | + // Attendee's can register for any of the date-times. |
|
148 | + 'recurring-event' => array( |
|
149 | + 'term' => esc_html__('Recurring Event', 'event_espresso'), |
|
150 | + 'desc' => esc_html__( |
|
151 | + 'Multiple events that occur over multiple non-consecutive days.', |
|
152 | + 'event_espresso' |
|
153 | + ), |
|
154 | + ), |
|
155 | + // example: a yoga class |
|
156 | + 'ongoing' => array( |
|
157 | + 'term' => esc_html__('Ongoing Event', 'event_espresso'), |
|
158 | + 'desc' => esc_html__( |
|
159 | + 'An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event', |
|
160 | + 'event_espresso' |
|
161 | + ), |
|
162 | + ) |
|
163 | + // example: access to a museum |
|
164 | + // 'walk-in' => array( esc_html__('Walk In', 'event_espresso'), esc_html__('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ), |
|
165 | + // 'reservation' => array( esc_html__('Reservation', 'event_espresso'), esc_html__('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1 |
|
166 | + // 'multiple-session' => array( esc_html__('Multiple Session', 'event_espresso'), esc_html__('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1 |
|
167 | + // 'appointment' => array( esc_html__('Appointments', 'event_espresso'), esc_html__('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') ) |
|
168 | + ); |
|
169 | + $this->setMustUseTerms('espresso_event_type', $term_details); |
|
170 | + } |
|
171 | + |
|
172 | + |
|
173 | + /** |
|
174 | + * wrapper method for handling the setting up of initial terms in the db (if they don't already exist). |
|
175 | + * Note this should ONLY be used for terms that always must be present. Be aware that if an initial term is |
|
176 | + * deleted then it WILL be recreated. |
|
177 | + * |
|
178 | + * @param string $taxonomy The name of the taxonomy |
|
179 | + * @param array $term_details An array of term details indexed by slug and containing Name of term, and |
|
180 | + * description as the elements in the array |
|
181 | + * @return void |
|
182 | + */ |
|
183 | + public function setMustUseTerms($taxonomy, $term_details) |
|
184 | + { |
|
185 | + $term_details = (array) $term_details; |
|
186 | + foreach ($term_details as $slug => $details) { |
|
187 | + if (isset($details['term'], $details['desc']) && ! term_exists($slug, $taxonomy)) { |
|
188 | + $insert_arr = array( |
|
189 | + 'slug' => $slug, |
|
190 | + 'description' => $details['desc'], |
|
191 | + ); |
|
192 | + wp_insert_term($details['term'], $taxonomy, $insert_arr); |
|
193 | + } |
|
194 | + } |
|
195 | + } |
|
196 | 196 | } |
@@ -47,7 +47,7 @@ |
||
47 | 47 | */ |
48 | 48 | public function __construct($generator) |
49 | 49 | { |
50 | - if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) { |
|
50 | + if ( ! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) { |
|
51 | 51 | throw new InvalidArgumentException( |
52 | 52 | esc_html__( |
53 | 53 | 'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.', |
@@ -29,108 +29,108 @@ |
||
29 | 29 | class CoreLoader implements LoaderDecoratorInterface |
30 | 30 | { |
31 | 31 | |
32 | - /** |
|
33 | - * @var EE_Registry|CoffeeShop $generator |
|
34 | - */ |
|
35 | - private $generator; |
|
32 | + /** |
|
33 | + * @var EE_Registry|CoffeeShop $generator |
|
34 | + */ |
|
35 | + private $generator; |
|
36 | 36 | |
37 | 37 | |
38 | - /** |
|
39 | - * CoreLoader constructor. |
|
40 | - * |
|
41 | - * @param EE_Registry|CoffeeShop $generator |
|
42 | - * @throws InvalidArgumentException |
|
43 | - */ |
|
44 | - public function __construct($generator) |
|
45 | - { |
|
46 | - if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) { |
|
47 | - throw new InvalidArgumentException( |
|
48 | - esc_html__( |
|
49 | - 'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.', |
|
50 | - 'event_espresso' |
|
51 | - ) |
|
52 | - ); |
|
53 | - } |
|
54 | - $this->generator = $generator; |
|
55 | - } |
|
38 | + /** |
|
39 | + * CoreLoader constructor. |
|
40 | + * |
|
41 | + * @param EE_Registry|CoffeeShop $generator |
|
42 | + * @throws InvalidArgumentException |
|
43 | + */ |
|
44 | + public function __construct($generator) |
|
45 | + { |
|
46 | + if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) { |
|
47 | + throw new InvalidArgumentException( |
|
48 | + esc_html__( |
|
49 | + 'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.', |
|
50 | + 'event_espresso' |
|
51 | + ) |
|
52 | + ); |
|
53 | + } |
|
54 | + $this->generator = $generator; |
|
55 | + } |
|
56 | 56 | |
57 | 57 | |
58 | - /** |
|
59 | - * Calls the appropriate loading method from the installed generator; |
|
60 | - * If EE_Registry is being used, then the additional parameters for the EE_Registry::create() method |
|
61 | - * can be added to the $arguments array and they will be extracted and passed to EE_Registry::create(), |
|
62 | - * but NOT to the class being instantiated. |
|
63 | - * This is done by adding the parameters to the $arguments array as follows: |
|
64 | - * array( |
|
65 | - * 'EE_Registry::create(from_db)' => true, // boolean value, default = false |
|
66 | - * 'EE_Registry::create(load_only)' => true, // boolean value, default = false |
|
67 | - * 'EE_Registry::create(addon)' => true, // boolean value, default = false |
|
68 | - * ) |
|
69 | - * |
|
70 | - * @param string $fqcn |
|
71 | - * @param array $arguments |
|
72 | - * @param bool $shared |
|
73 | - * @return mixed |
|
74 | - * @throws OutOfBoundsException |
|
75 | - * @throws ServiceExistsException |
|
76 | - * @throws InstantiationException |
|
77 | - * @throws InvalidIdentifierException |
|
78 | - * @throws InvalidDataTypeException |
|
79 | - * @throws InvalidClassException |
|
80 | - * @throws EE_Error |
|
81 | - * @throws ServiceNotFoundException |
|
82 | - * @throws ReflectionException |
|
83 | - * @throws InvalidInterfaceException |
|
84 | - * @throws InvalidArgumentException |
|
85 | - */ |
|
86 | - public function load($fqcn, $arguments = array(), $shared = true) |
|
87 | - { |
|
88 | - $shared = filter_var($shared, FILTER_VALIDATE_BOOLEAN); |
|
89 | - if ($this->generator instanceof EE_Registry) { |
|
90 | - // check if additional EE_Registry::create() arguments have been passed |
|
91 | - // from_db |
|
92 | - $from_db = isset($arguments['EE_Registry::create(from_db)']) |
|
93 | - ? filter_var($arguments['EE_Registry::create(from_db)'], FILTER_VALIDATE_BOOLEAN) |
|
94 | - : false; |
|
95 | - // load_only |
|
96 | - $load_only = isset($arguments['EE_Registry::create(load_only)']) |
|
97 | - ? filter_var($arguments['EE_Registry::create(load_only)'], FILTER_VALIDATE_BOOLEAN) |
|
98 | - : false; |
|
99 | - // addon |
|
100 | - $addon = isset($arguments['EE_Registry::create(addon)']) |
|
101 | - ? filter_var($arguments['EE_Registry::create(addon)'], FILTER_VALIDATE_BOOLEAN) |
|
102 | - : false; |
|
103 | - unset( |
|
104 | - $arguments['EE_Registry::create(from_db)'], |
|
105 | - $arguments['EE_Registry::create(load_only)'], |
|
106 | - $arguments['EE_Registry::create(addon)'] |
|
107 | - ); |
|
108 | - // addons need to be cached on EE_Registry |
|
109 | - $shared = $addon ? true : $shared; |
|
110 | - return $this->generator->create( |
|
111 | - $fqcn, |
|
112 | - $arguments, |
|
113 | - $shared, |
|
114 | - $from_db, |
|
115 | - $load_only, |
|
116 | - $addon |
|
117 | - ); |
|
118 | - } |
|
119 | - return $this->generator->brew( |
|
120 | - $fqcn, |
|
121 | - $arguments, |
|
122 | - $shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW |
|
123 | - ); |
|
124 | - } |
|
58 | + /** |
|
59 | + * Calls the appropriate loading method from the installed generator; |
|
60 | + * If EE_Registry is being used, then the additional parameters for the EE_Registry::create() method |
|
61 | + * can be added to the $arguments array and they will be extracted and passed to EE_Registry::create(), |
|
62 | + * but NOT to the class being instantiated. |
|
63 | + * This is done by adding the parameters to the $arguments array as follows: |
|
64 | + * array( |
|
65 | + * 'EE_Registry::create(from_db)' => true, // boolean value, default = false |
|
66 | + * 'EE_Registry::create(load_only)' => true, // boolean value, default = false |
|
67 | + * 'EE_Registry::create(addon)' => true, // boolean value, default = false |
|
68 | + * ) |
|
69 | + * |
|
70 | + * @param string $fqcn |
|
71 | + * @param array $arguments |
|
72 | + * @param bool $shared |
|
73 | + * @return mixed |
|
74 | + * @throws OutOfBoundsException |
|
75 | + * @throws ServiceExistsException |
|
76 | + * @throws InstantiationException |
|
77 | + * @throws InvalidIdentifierException |
|
78 | + * @throws InvalidDataTypeException |
|
79 | + * @throws InvalidClassException |
|
80 | + * @throws EE_Error |
|
81 | + * @throws ServiceNotFoundException |
|
82 | + * @throws ReflectionException |
|
83 | + * @throws InvalidInterfaceException |
|
84 | + * @throws InvalidArgumentException |
|
85 | + */ |
|
86 | + public function load($fqcn, $arguments = array(), $shared = true) |
|
87 | + { |
|
88 | + $shared = filter_var($shared, FILTER_VALIDATE_BOOLEAN); |
|
89 | + if ($this->generator instanceof EE_Registry) { |
|
90 | + // check if additional EE_Registry::create() arguments have been passed |
|
91 | + // from_db |
|
92 | + $from_db = isset($arguments['EE_Registry::create(from_db)']) |
|
93 | + ? filter_var($arguments['EE_Registry::create(from_db)'], FILTER_VALIDATE_BOOLEAN) |
|
94 | + : false; |
|
95 | + // load_only |
|
96 | + $load_only = isset($arguments['EE_Registry::create(load_only)']) |
|
97 | + ? filter_var($arguments['EE_Registry::create(load_only)'], FILTER_VALIDATE_BOOLEAN) |
|
98 | + : false; |
|
99 | + // addon |
|
100 | + $addon = isset($arguments['EE_Registry::create(addon)']) |
|
101 | + ? filter_var($arguments['EE_Registry::create(addon)'], FILTER_VALIDATE_BOOLEAN) |
|
102 | + : false; |
|
103 | + unset( |
|
104 | + $arguments['EE_Registry::create(from_db)'], |
|
105 | + $arguments['EE_Registry::create(load_only)'], |
|
106 | + $arguments['EE_Registry::create(addon)'] |
|
107 | + ); |
|
108 | + // addons need to be cached on EE_Registry |
|
109 | + $shared = $addon ? true : $shared; |
|
110 | + return $this->generator->create( |
|
111 | + $fqcn, |
|
112 | + $arguments, |
|
113 | + $shared, |
|
114 | + $from_db, |
|
115 | + $load_only, |
|
116 | + $addon |
|
117 | + ); |
|
118 | + } |
|
119 | + return $this->generator->brew( |
|
120 | + $fqcn, |
|
121 | + $arguments, |
|
122 | + $shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW |
|
123 | + ); |
|
124 | + } |
|
125 | 125 | |
126 | 126 | |
127 | - /** |
|
128 | - * calls reset() on generator if method exists |
|
129 | - */ |
|
130 | - public function reset() |
|
131 | - { |
|
132 | - if ($this->generator instanceof ResettableInterface) { |
|
133 | - $this->generator->reset(); |
|
134 | - } |
|
135 | - } |
|
127 | + /** |
|
128 | + * calls reset() on generator if method exists |
|
129 | + */ |
|
130 | + public function reset() |
|
131 | + { |
|
132 | + if ($this->generator instanceof ResettableInterface) { |
|
133 | + $this->generator->reset(); |
|
134 | + } |
|
135 | + } |
|
136 | 136 | } |