@@ -61,15 +61,15 @@ discard block |
||
| 61 | 61 | |
| 62 | 62 | |
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * @param array $props_n_values incoming values |
|
| 66 | - * @param string $timezone incoming timezone (if not set the timezone set for the website will be |
|
| 67 | - * used.) |
|
| 68 | - * @param array $date_formats incoming date_formats in an array where the first value is the |
|
| 69 | - * date_format and the second value is the time format |
|
| 70 | - * @return EE_Ticket |
|
| 71 | - * @throws \EE_Error |
|
| 72 | - */ |
|
| 64 | + /** |
|
| 65 | + * @param array $props_n_values incoming values |
|
| 66 | + * @param string $timezone incoming timezone (if not set the timezone set for the website will be |
|
| 67 | + * used.) |
|
| 68 | + * @param array $date_formats incoming date_formats in an array where the first value is the |
|
| 69 | + * date_format and the second value is the time format |
|
| 70 | + * @return EE_Ticket |
|
| 71 | + * @throws \EE_Error |
|
| 72 | + */ |
|
| 73 | 73 | public static function new_instance( $props_n_values = array(), $timezone = null, $date_formats = array() ) { |
| 74 | 74 | $has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone, $date_formats ); |
| 75 | 75 | return $has_object ? $has_object : new self( $props_n_values, false, $timezone, $date_formats ); |
@@ -77,36 +77,36 @@ discard block |
||
| 77 | 77 | |
| 78 | 78 | |
| 79 | 79 | |
| 80 | - /** |
|
| 81 | - * @param array $props_n_values incoming values from the database |
|
| 82 | - * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
| 83 | - * the website will be used. |
|
| 84 | - * @return EE_Ticket |
|
| 85 | - * @throws \EE_Error |
|
| 86 | - */ |
|
| 80 | + /** |
|
| 81 | + * @param array $props_n_values incoming values from the database |
|
| 82 | + * @param string $timezone incoming timezone as set by the model. If not set the timezone for |
|
| 83 | + * the website will be used. |
|
| 84 | + * @return EE_Ticket |
|
| 85 | + * @throws \EE_Error |
|
| 86 | + */ |
|
| 87 | 87 | public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) { |
| 88 | 88 | return new self( $props_n_values, TRUE, $timezone ); |
| 89 | 89 | } |
| 90 | 90 | |
| 91 | 91 | |
| 92 | 92 | |
| 93 | - /** |
|
| 94 | - * @return bool |
|
| 95 | - * @throws \EE_Error |
|
| 96 | - */ |
|
| 93 | + /** |
|
| 94 | + * @return bool |
|
| 95 | + * @throws \EE_Error |
|
| 96 | + */ |
|
| 97 | 97 | public function parent() { |
| 98 | 98 | return $this->get( 'TKT_parent' ); |
| 99 | 99 | } |
| 100 | 100 | |
| 101 | 101 | |
| 102 | 102 | |
| 103 | - /** |
|
| 104 | - * return if a ticket has quantities available for purchase |
|
| 105 | - * |
|
| 106 | - * @param int $DTT_ID the primary key for a particular datetime |
|
| 107 | - * @return boolean |
|
| 108 | - * @throws \EE_Error |
|
| 109 | - */ |
|
| 103 | + /** |
|
| 104 | + * return if a ticket has quantities available for purchase |
|
| 105 | + * |
|
| 106 | + * @param int $DTT_ID the primary key for a particular datetime |
|
| 107 | + * @return boolean |
|
| 108 | + * @throws \EE_Error |
|
| 109 | + */ |
|
| 110 | 110 | public function available( $DTT_ID = 0 ) { |
| 111 | 111 | // are we checking availability for a particular datetime ? |
| 112 | 112 | if ( $DTT_ID ) { |
@@ -123,14 +123,14 @@ discard block |
||
| 123 | 123 | |
| 124 | 124 | |
| 125 | 125 | |
| 126 | - /** |
|
| 127 | - * Using the start date and end date this method calculates whether the ticket is On Sale, Pending, or Expired |
|
| 128 | - * |
|
| 129 | - * @param bool $display true = we'll return a localized string, otherwise we just return the value of the relevant status const |
|
| 130 | - * @param bool | null $remaining if it is already known that tickets are available, then simply pass a bool to save further processing |
|
| 131 | - * @return mixed status int if the display string isn't requested |
|
| 132 | - * @throws \EE_Error |
|
| 133 | - */ |
|
| 126 | + /** |
|
| 127 | + * Using the start date and end date this method calculates whether the ticket is On Sale, Pending, or Expired |
|
| 128 | + * |
|
| 129 | + * @param bool $display true = we'll return a localized string, otherwise we just return the value of the relevant status const |
|
| 130 | + * @param bool | null $remaining if it is already known that tickets are available, then simply pass a bool to save further processing |
|
| 131 | + * @return mixed status int if the display string isn't requested |
|
| 132 | + * @throws \EE_Error |
|
| 133 | + */ |
|
| 134 | 134 | public function ticket_status( $display = FALSE, $remaining = null ) { |
| 135 | 135 | $remaining = is_bool( $remaining ) ? $remaining : $this->is_remaining(); |
| 136 | 136 | if ( ! $remaining ) { |
@@ -153,14 +153,14 @@ discard block |
||
| 153 | 153 | |
| 154 | 154 | |
| 155 | 155 | |
| 156 | - /** |
|
| 157 | - * The purpose of this method is to simply return a boolean for whether there are any tickets remaining for sale considering ALL the factors used for figuring that out. |
|
| 158 | - * |
|
| 159 | - * @access public |
|
| 160 | - * @param int $DTT_ID if an int above 0 is included here then we get a specific dtt. |
|
| 161 | - * @return boolean true = tickets remaining, false not. |
|
| 162 | - * @throws \EE_Error |
|
| 163 | - */ |
|
| 156 | + /** |
|
| 157 | + * The purpose of this method is to simply return a boolean for whether there are any tickets remaining for sale considering ALL the factors used for figuring that out. |
|
| 158 | + * |
|
| 159 | + * @access public |
|
| 160 | + * @param int $DTT_ID if an int above 0 is included here then we get a specific dtt. |
|
| 161 | + * @return boolean true = tickets remaining, false not. |
|
| 162 | + * @throws \EE_Error |
|
| 163 | + */ |
|
| 164 | 164 | public function is_remaining( $DTT_ID = 0 ) { |
| 165 | 165 | $num_remaining = $this->remaining( $DTT_ID ); |
| 166 | 166 | if ( $num_remaining === 0 ) { |
@@ -174,76 +174,76 @@ discard block |
||
| 174 | 174 | |
| 175 | 175 | |
| 176 | 176 | |
| 177 | - /** |
|
| 178 | - * return the total number of tickets available for purchase |
|
| 179 | - * |
|
| 180 | - * @param int $DTT_ID the primary key for a particular datetime. |
|
| 181 | - * set to 0 for all related datetimes |
|
| 182 | - * @return int |
|
| 183 | - * @throws \EE_Error |
|
| 184 | - */ |
|
| 177 | + /** |
|
| 178 | + * return the total number of tickets available for purchase |
|
| 179 | + * |
|
| 180 | + * @param int $DTT_ID the primary key for a particular datetime. |
|
| 181 | + * set to 0 for all related datetimes |
|
| 182 | + * @return int |
|
| 183 | + * @throws \EE_Error |
|
| 184 | + */ |
|
| 185 | 185 | public function remaining( $DTT_ID = 0 ) { |
| 186 | 186 | return $this->real_quantity_on_ticket('saleable', $DTT_ID ); |
| 187 | 187 | } |
| 188 | 188 | |
| 189 | 189 | |
| 190 | 190 | |
| 191 | - /** |
|
| 192 | - * Gets min |
|
| 193 | - * |
|
| 194 | - * @return int |
|
| 195 | - * @throws \EE_Error |
|
| 196 | - */ |
|
| 191 | + /** |
|
| 192 | + * Gets min |
|
| 193 | + * |
|
| 194 | + * @return int |
|
| 195 | + * @throws \EE_Error |
|
| 196 | + */ |
|
| 197 | 197 | public function min() { |
| 198 | 198 | return $this->get( 'TKT_min' ); |
| 199 | 199 | } |
| 200 | 200 | |
| 201 | 201 | |
| 202 | 202 | |
| 203 | - /** |
|
| 204 | - * return if a ticket is no longer available cause its available dates have expired. |
|
| 205 | - * |
|
| 206 | - * @return boolean |
|
| 207 | - * @throws \EE_Error |
|
| 208 | - */ |
|
| 203 | + /** |
|
| 204 | + * return if a ticket is no longer available cause its available dates have expired. |
|
| 205 | + * |
|
| 206 | + * @return boolean |
|
| 207 | + * @throws \EE_Error |
|
| 208 | + */ |
|
| 209 | 209 | public function is_expired() { |
| 210 | 210 | return ( $this->get_raw( 'TKT_end_date' ) < time() ); |
| 211 | 211 | } |
| 212 | 212 | |
| 213 | 213 | |
| 214 | 214 | |
| 215 | - /** |
|
| 216 | - * Return if a ticket is yet to go on sale or not |
|
| 217 | - * |
|
| 218 | - * @return boolean |
|
| 219 | - * @throws \EE_Error |
|
| 220 | - */ |
|
| 215 | + /** |
|
| 216 | + * Return if a ticket is yet to go on sale or not |
|
| 217 | + * |
|
| 218 | + * @return boolean |
|
| 219 | + * @throws \EE_Error |
|
| 220 | + */ |
|
| 221 | 221 | public function is_pending() { |
| 222 | 222 | return ( $this->get_raw( 'TKT_start_date' ) > time() ); |
| 223 | 223 | } |
| 224 | 224 | |
| 225 | 225 | |
| 226 | 226 | |
| 227 | - /** |
|
| 228 | - * Return if a ticket is on sale or not |
|
| 229 | - * |
|
| 230 | - * @return boolean |
|
| 231 | - * @throws \EE_Error |
|
| 232 | - */ |
|
| 227 | + /** |
|
| 228 | + * Return if a ticket is on sale or not |
|
| 229 | + * |
|
| 230 | + * @return boolean |
|
| 231 | + * @throws \EE_Error |
|
| 232 | + */ |
|
| 233 | 233 | public function is_on_sale() { |
| 234 | 234 | return ( $this->get_raw( 'TKT_start_date' ) < time() && $this->get_raw( 'TKT_end_date' ) > time() ); |
| 235 | 235 | } |
| 236 | 236 | |
| 237 | 237 | |
| 238 | 238 | |
| 239 | - /** |
|
| 240 | - * This returns the chronologically last datetime that this ticket is associated with |
|
| 241 | - * |
|
| 242 | - * @param string $dt_frmt |
|
| 243 | - * @param string $conjunction - conjunction junction what's your function ? this string joins the start date with the end date ie: Jan 01 "to" Dec 31 |
|
| 244 | - * @return string |
|
| 245 | - * @throws \EE_Error |
|
| 246 | - */ |
|
| 239 | + /** |
|
| 240 | + * This returns the chronologically last datetime that this ticket is associated with |
|
| 241 | + * |
|
| 242 | + * @param string $dt_frmt |
|
| 243 | + * @param string $conjunction - conjunction junction what's your function ? this string joins the start date with the end date ie: Jan 01 "to" Dec 31 |
|
| 244 | + * @return string |
|
| 245 | + * @throws \EE_Error |
|
| 246 | + */ |
|
| 247 | 247 | public function date_range( $dt_frmt = '', $conjunction = ' - ' ) { |
| 248 | 248 | $first_date = $this->first_datetime() instanceof EE_Datetime ? $this->first_datetime()->start_date( $dt_frmt ) : ''; |
| 249 | 249 | $last_date = $this->last_datetime() instanceof EE_Datetime ? $this->last_datetime()->end_date( $dt_frmt ) : ''; |
@@ -253,12 +253,12 @@ discard block |
||
| 253 | 253 | |
| 254 | 254 | |
| 255 | 255 | |
| 256 | - /** |
|
| 257 | - * This returns the chronologically first datetime that this ticket is associated with |
|
| 258 | - * |
|
| 259 | - * @return EE_Datetime |
|
| 260 | - * @throws \EE_Error |
|
| 261 | - */ |
|
| 256 | + /** |
|
| 257 | + * This returns the chronologically first datetime that this ticket is associated with |
|
| 258 | + * |
|
| 259 | + * @return EE_Datetime |
|
| 260 | + * @throws \EE_Error |
|
| 261 | + */ |
|
| 262 | 262 | public function first_datetime() { |
| 263 | 263 | $datetimes = $this->datetimes( array( 'limit' => 1 ) ); |
| 264 | 264 | return reset( $datetimes ); |
@@ -266,14 +266,14 @@ discard block |
||
| 266 | 266 | |
| 267 | 267 | |
| 268 | 268 | |
| 269 | - /** |
|
| 270 | - * Gets all the datetimes this ticket can be used for attending. |
|
| 271 | - * Unless otherwise specified, orders datetimes by start date. |
|
| 272 | - * |
|
| 273 | - * @param array $query_params see EEM_Base::get_all() |
|
| 274 | - * @return EE_Datetime[]|EE_Base_Class[] |
|
| 275 | - * @throws \EE_Error |
|
| 276 | - */ |
|
| 269 | + /** |
|
| 270 | + * Gets all the datetimes this ticket can be used for attending. |
|
| 271 | + * Unless otherwise specified, orders datetimes by start date. |
|
| 272 | + * |
|
| 273 | + * @param array $query_params see EEM_Base::get_all() |
|
| 274 | + * @return EE_Datetime[]|EE_Base_Class[] |
|
| 275 | + * @throws \EE_Error |
|
| 276 | + */ |
|
| 277 | 277 | public function datetimes( $query_params = array() ) { |
| 278 | 278 | if ( ! isset( $query_params[ 'order_by' ] ) ) { |
| 279 | 279 | $query_params[ 'order_by' ][ 'DTT_order' ] = 'ASC'; |
@@ -283,12 +283,12 @@ discard block |
||
| 283 | 283 | |
| 284 | 284 | |
| 285 | 285 | |
| 286 | - /** |
|
| 287 | - * This returns the chronologically last datetime that this ticket is associated with |
|
| 288 | - * |
|
| 289 | - * @return EE_Datetime |
|
| 290 | - * @throws \EE_Error |
|
| 291 | - */ |
|
| 286 | + /** |
|
| 287 | + * This returns the chronologically last datetime that this ticket is associated with |
|
| 288 | + * |
|
| 289 | + * @return EE_Datetime |
|
| 290 | + * @throws \EE_Error |
|
| 291 | + */ |
|
| 292 | 292 | public function last_datetime() { |
| 293 | 293 | $datetimes = $this->datetimes( array( 'limit' => 1, 'order_by' => array( 'DTT_EVT_start' => 'DESC' ) ) ); |
| 294 | 294 | return end( $datetimes ); |
@@ -296,19 +296,19 @@ discard block |
||
| 296 | 296 | |
| 297 | 297 | |
| 298 | 298 | |
| 299 | - /** |
|
| 300 | - * This returns the total tickets sold depending on the given parameters. |
|
| 301 | - * |
|
| 302 | - * @param string $what Can be one of two options: 'ticket', 'datetime'. |
|
| 303 | - * 'ticket' = total ticket sales for all datetimes this ticket is related to |
|
| 304 | - * 'datetime' = total ticket sales for a specified datetime (required $dtt_id) |
|
| 305 | - * 'datetime' = total ticket sales in the datetime_ticket table. |
|
| 306 | - * If $dtt_id is not given then we return an array of sales indexed by datetime. |
|
| 307 | - * If $dtt_id IS given then we return the tickets sold for that given datetime. |
|
| 308 | - * @param int $dtt_id [optional] include the dtt_id with $what = 'datetime'. |
|
| 309 | - * @return mixed (array|int) how many tickets have sold |
|
| 310 | - * @throws \EE_Error |
|
| 311 | - */ |
|
| 299 | + /** |
|
| 300 | + * This returns the total tickets sold depending on the given parameters. |
|
| 301 | + * |
|
| 302 | + * @param string $what Can be one of two options: 'ticket', 'datetime'. |
|
| 303 | + * 'ticket' = total ticket sales for all datetimes this ticket is related to |
|
| 304 | + * 'datetime' = total ticket sales for a specified datetime (required $dtt_id) |
|
| 305 | + * 'datetime' = total ticket sales in the datetime_ticket table. |
|
| 306 | + * If $dtt_id is not given then we return an array of sales indexed by datetime. |
|
| 307 | + * If $dtt_id IS given then we return the tickets sold for that given datetime. |
|
| 308 | + * @param int $dtt_id [optional] include the dtt_id with $what = 'datetime'. |
|
| 309 | + * @return mixed (array|int) how many tickets have sold |
|
| 310 | + * @throws \EE_Error |
|
| 311 | + */ |
|
| 312 | 312 | public function tickets_sold( $what = 'ticket', $dtt_id = NULL ) { |
| 313 | 313 | $total = 0; |
| 314 | 314 | $tickets_sold = $this->_all_tickets_sold(); |
@@ -333,12 +333,12 @@ discard block |
||
| 333 | 333 | |
| 334 | 334 | |
| 335 | 335 | |
| 336 | - /** |
|
| 337 | - * This returns an array indexed by datetime_id for tickets sold with this ticket. |
|
| 338 | - * |
|
| 339 | - * @return EE_Ticket[] |
|
| 340 | - * @throws \EE_Error |
|
| 341 | - */ |
|
| 336 | + /** |
|
| 337 | + * This returns an array indexed by datetime_id for tickets sold with this ticket. |
|
| 338 | + * |
|
| 339 | + * @return EE_Ticket[] |
|
| 340 | + * @throws \EE_Error |
|
| 341 | + */ |
|
| 342 | 342 | protected function _all_tickets_sold() { |
| 343 | 343 | $datetimes = $this->get_many_related( 'Datetime' ); |
| 344 | 344 | $tickets_sold = array(); |
@@ -354,29 +354,29 @@ discard block |
||
| 354 | 354 | |
| 355 | 355 | |
| 356 | 356 | |
| 357 | - /** |
|
| 358 | - * This returns the base price object for the ticket. |
|
| 359 | - * |
|
| 360 | - * @param bool $return_array whether to return as an array indexed by price id or just the object. |
|
| 361 | - * @return EE_Price|EE_Base_Class|EE_Price[]|EE_Base_Class[] |
|
| 362 | - * @throws \EE_Error |
|
| 363 | - */ |
|
| 357 | + /** |
|
| 358 | + * This returns the base price object for the ticket. |
|
| 359 | + * |
|
| 360 | + * @param bool $return_array whether to return as an array indexed by price id or just the object. |
|
| 361 | + * @return EE_Price|EE_Base_Class|EE_Price[]|EE_Base_Class[] |
|
| 362 | + * @throws \EE_Error |
|
| 363 | + */ |
|
| 364 | 364 | public function base_price( $return_array = FALSE ) { |
| 365 | 365 | $_where = array( 'Price_Type.PBT_ID' => EEM_Price_Type::base_type_base_price ); |
| 366 | 366 | return $return_array |
| 367 | - ? $this->get_many_related( 'Price', array( $_where ) ) |
|
| 368 | - : $this->get_first_related( 'Price', array( $_where ) ); |
|
| 367 | + ? $this->get_many_related( 'Price', array( $_where ) ) |
|
| 368 | + : $this->get_first_related( 'Price', array( $_where ) ); |
|
| 369 | 369 | } |
| 370 | 370 | |
| 371 | 371 | |
| 372 | 372 | |
| 373 | - /** |
|
| 374 | - * This returns ONLY the price modifiers for the ticket (i.e. no taxes or base price) |
|
| 375 | - * |
|
| 376 | - * @access public |
|
| 377 | - * @return EE_Price[] |
|
| 378 | - * @throws \EE_Error |
|
| 379 | - */ |
|
| 373 | + /** |
|
| 374 | + * This returns ONLY the price modifiers for the ticket (i.e. no taxes or base price) |
|
| 375 | + * |
|
| 376 | + * @access public |
|
| 377 | + * @return EE_Price[] |
|
| 378 | + * @throws \EE_Error |
|
| 379 | + */ |
|
| 380 | 380 | public function price_modifiers() { |
| 381 | 381 | $query_params = array( 0 => array( 'Price_Type.PBT_ID' => array( 'NOT IN', array( EEM_Price_Type::base_type_base_price, EEM_Price_Type::base_type_tax ) ) ) ); |
| 382 | 382 | return $this->prices( $query_params ); |
@@ -384,132 +384,132 @@ discard block |
||
| 384 | 384 | |
| 385 | 385 | |
| 386 | 386 | |
| 387 | - /** |
|
| 388 | - * Gets all the prices that combine to form the final price of this ticket |
|
| 389 | - * |
|
| 390 | - * @param array $query_params like EEM_Base::get_all |
|
| 391 | - * @return EE_Price[]|EE_Base_Class[] |
|
| 392 | - * @throws \EE_Error |
|
| 393 | - */ |
|
| 387 | + /** |
|
| 388 | + * Gets all the prices that combine to form the final price of this ticket |
|
| 389 | + * |
|
| 390 | + * @param array $query_params like EEM_Base::get_all |
|
| 391 | + * @return EE_Price[]|EE_Base_Class[] |
|
| 392 | + * @throws \EE_Error |
|
| 393 | + */ |
|
| 394 | 394 | public function prices( $query_params = array() ) { |
| 395 | 395 | return $this->get_many_related( 'Price', $query_params ); |
| 396 | 396 | } |
| 397 | 397 | |
| 398 | 398 | |
| 399 | 399 | |
| 400 | - /** |
|
| 401 | - * Gets all the ticket applicabilities (ie, relations between datetimes and tickets) |
|
| 402 | - * |
|
| 403 | - * @param array $query_params see EEM_Base::get_all() |
|
| 404 | - * @return EE_Datetime_Ticket|EE_Base_Class[] |
|
| 405 | - * @throws \EE_Error |
|
| 406 | - */ |
|
| 400 | + /** |
|
| 401 | + * Gets all the ticket applicabilities (ie, relations between datetimes and tickets) |
|
| 402 | + * |
|
| 403 | + * @param array $query_params see EEM_Base::get_all() |
|
| 404 | + * @return EE_Datetime_Ticket|EE_Base_Class[] |
|
| 405 | + * @throws \EE_Error |
|
| 406 | + */ |
|
| 407 | 407 | public function datetime_tickets( $query_params = array() ) { |
| 408 | 408 | return $this->get_many_related( 'Datetime_Ticket', $query_params ); |
| 409 | 409 | } |
| 410 | 410 | |
| 411 | 411 | |
| 412 | 412 | |
| 413 | - /** |
|
| 414 | - * Gets all the datetimes from the db ordered by DTT_order |
|
| 415 | - * |
|
| 416 | - * @param boolean $show_expired |
|
| 417 | - * @param boolean $show_deleted |
|
| 418 | - * @return EE_Datetime[] |
|
| 419 | - * @throws \EE_Error |
|
| 420 | - */ |
|
| 413 | + /** |
|
| 414 | + * Gets all the datetimes from the db ordered by DTT_order |
|
| 415 | + * |
|
| 416 | + * @param boolean $show_expired |
|
| 417 | + * @param boolean $show_deleted |
|
| 418 | + * @return EE_Datetime[] |
|
| 419 | + * @throws \EE_Error |
|
| 420 | + */ |
|
| 421 | 421 | public function datetimes_ordered( $show_expired = TRUE, $show_deleted = FALSE ) { |
| 422 | 422 | return EEM_Datetime::instance( $this->_timezone )->get_datetimes_for_ticket_ordered_by_DTT_order( $this->ID(), $show_expired, $show_deleted ); |
| 423 | 423 | } |
| 424 | 424 | |
| 425 | 425 | |
| 426 | 426 | |
| 427 | - /** |
|
| 428 | - * Gets ID |
|
| 429 | - * |
|
| 430 | - * @return string |
|
| 431 | - * @throws \EE_Error |
|
| 432 | - */ |
|
| 427 | + /** |
|
| 428 | + * Gets ID |
|
| 429 | + * |
|
| 430 | + * @return string |
|
| 431 | + * @throws \EE_Error |
|
| 432 | + */ |
|
| 433 | 433 | public function ID() { |
| 434 | 434 | return $this->get( 'TKT_ID' ); |
| 435 | 435 | } |
| 436 | 436 | |
| 437 | 437 | |
| 438 | 438 | |
| 439 | - /** |
|
| 440 | - * get the author of the ticket. |
|
| 441 | - * |
|
| 442 | - * @since 4.5.0 |
|
| 443 | - * @return int |
|
| 444 | - * @throws \EE_Error |
|
| 445 | - */ |
|
| 439 | + /** |
|
| 440 | + * get the author of the ticket. |
|
| 441 | + * |
|
| 442 | + * @since 4.5.0 |
|
| 443 | + * @return int |
|
| 444 | + * @throws \EE_Error |
|
| 445 | + */ |
|
| 446 | 446 | public function wp_user() { |
| 447 | 447 | return $this->get('TKT_wp_user'); |
| 448 | 448 | } |
| 449 | 449 | |
| 450 | 450 | |
| 451 | 451 | |
| 452 | - /** |
|
| 453 | - * Gets the template for the ticket |
|
| 454 | - * |
|
| 455 | - * @return EE_Ticket_Template|EE_Base_Class |
|
| 456 | - * @throws \EE_Error |
|
| 457 | - */ |
|
| 452 | + /** |
|
| 453 | + * Gets the template for the ticket |
|
| 454 | + * |
|
| 455 | + * @return EE_Ticket_Template|EE_Base_Class |
|
| 456 | + * @throws \EE_Error |
|
| 457 | + */ |
|
| 458 | 458 | public function template() { |
| 459 | 459 | return $this->get_first_related( 'Ticket_Template' ); |
| 460 | 460 | } |
| 461 | 461 | |
| 462 | 462 | |
| 463 | 463 | |
| 464 | - /** |
|
| 465 | - * Simply returns an array of EE_Price objects that are taxes. |
|
| 466 | - * |
|
| 467 | - * @return EE_Price[] |
|
| 468 | - * @throws \EE_Error |
|
| 469 | - */ |
|
| 464 | + /** |
|
| 465 | + * Simply returns an array of EE_Price objects that are taxes. |
|
| 466 | + * |
|
| 467 | + * @return EE_Price[] |
|
| 468 | + * @throws \EE_Error |
|
| 469 | + */ |
|
| 470 | 470 | public function get_ticket_taxes_for_admin() { |
| 471 | 471 | return EE_Taxes::get_taxes_for_admin(); |
| 472 | 472 | } |
| 473 | 473 | |
| 474 | 474 | |
| 475 | 475 | |
| 476 | - /** |
|
| 477 | - * @return float |
|
| 478 | - * @throws \EE_Error |
|
| 479 | - */ |
|
| 476 | + /** |
|
| 477 | + * @return float |
|
| 478 | + * @throws \EE_Error |
|
| 479 | + */ |
|
| 480 | 480 | public function ticket_price() { |
| 481 | 481 | return $this->get( 'TKT_price' ); |
| 482 | 482 | } |
| 483 | 483 | |
| 484 | 484 | |
| 485 | 485 | |
| 486 | - /** |
|
| 487 | - * @return mixed |
|
| 488 | - * @throws \EE_Error |
|
| 489 | - */ |
|
| 486 | + /** |
|
| 487 | + * @return mixed |
|
| 488 | + * @throws \EE_Error |
|
| 489 | + */ |
|
| 490 | 490 | public function pretty_price() { |
| 491 | 491 | return $this->get_pretty( 'TKT_price' ); |
| 492 | 492 | } |
| 493 | 493 | |
| 494 | 494 | |
| 495 | 495 | |
| 496 | - /** |
|
| 497 | - * @return bool |
|
| 498 | - * @throws \EE_Error |
|
| 499 | - */ |
|
| 496 | + /** |
|
| 497 | + * @return bool |
|
| 498 | + * @throws \EE_Error |
|
| 499 | + */ |
|
| 500 | 500 | public function is_free() { |
| 501 | 501 | return $this->get_ticket_total_with_taxes() === (float) 0; |
| 502 | 502 | } |
| 503 | 503 | |
| 504 | 504 | |
| 505 | 505 | |
| 506 | - /** |
|
| 507 | - * get_ticket_total_with_taxes |
|
| 508 | - * |
|
| 509 | - * @param bool $no_cache |
|
| 510 | - * @return float |
|
| 511 | - * @throws \EE_Error |
|
| 512 | - */ |
|
| 506 | + /** |
|
| 507 | + * get_ticket_total_with_taxes |
|
| 508 | + * |
|
| 509 | + * @param bool $no_cache |
|
| 510 | + * @return float |
|
| 511 | + * @throws \EE_Error |
|
| 512 | + */ |
|
| 513 | 513 | public function get_ticket_total_with_taxes( $no_cache = FALSE ) { |
| 514 | 514 | if ($this->_ticket_total_with_taxes === null || $no_cache ) { |
| 515 | 515 | $this->_ticket_total_with_taxes = $this->get_ticket_subtotal() + $this->get_ticket_taxes_total_for_admin(); |
@@ -526,201 +526,201 @@ discard block |
||
| 526 | 526 | |
| 527 | 527 | |
| 528 | 528 | |
| 529 | - /** |
|
| 530 | - * @return float |
|
| 531 | - * @throws \EE_Error |
|
| 532 | - */ |
|
| 529 | + /** |
|
| 530 | + * @return float |
|
| 531 | + * @throws \EE_Error |
|
| 532 | + */ |
|
| 533 | 533 | public function get_ticket_subtotal() { |
| 534 | 534 | return EE_Taxes::get_subtotal_for_admin( $this ); |
| 535 | 535 | } |
| 536 | 536 | |
| 537 | 537 | |
| 538 | 538 | |
| 539 | - /** |
|
| 540 | - * Returns the total taxes applied to this ticket |
|
| 541 | - * |
|
| 542 | - * @return float |
|
| 543 | - * @throws \EE_Error |
|
| 544 | - */ |
|
| 539 | + /** |
|
| 540 | + * Returns the total taxes applied to this ticket |
|
| 541 | + * |
|
| 542 | + * @return float |
|
| 543 | + * @throws \EE_Error |
|
| 544 | + */ |
|
| 545 | 545 | public function get_ticket_taxes_total_for_admin() { |
| 546 | 546 | return EE_Taxes::get_total_taxes_for_admin( $this ); |
| 547 | 547 | } |
| 548 | 548 | |
| 549 | 549 | |
| 550 | 550 | |
| 551 | - /** |
|
| 552 | - * Sets name |
|
| 553 | - * |
|
| 554 | - * @param string $name |
|
| 555 | - * @throws \EE_Error |
|
| 556 | - */ |
|
| 551 | + /** |
|
| 552 | + * Sets name |
|
| 553 | + * |
|
| 554 | + * @param string $name |
|
| 555 | + * @throws \EE_Error |
|
| 556 | + */ |
|
| 557 | 557 | public function set_name( $name ) { |
| 558 | 558 | $this->set( 'TKT_name', $name ); |
| 559 | 559 | } |
| 560 | 560 | |
| 561 | 561 | |
| 562 | 562 | |
| 563 | - /** |
|
| 564 | - * Gets description |
|
| 565 | - * |
|
| 566 | - * @return string |
|
| 567 | - * @throws \EE_Error |
|
| 568 | - */ |
|
| 563 | + /** |
|
| 564 | + * Gets description |
|
| 565 | + * |
|
| 566 | + * @return string |
|
| 567 | + * @throws \EE_Error |
|
| 568 | + */ |
|
| 569 | 569 | public function description() { |
| 570 | 570 | return $this->get( 'TKT_description' ); |
| 571 | 571 | } |
| 572 | 572 | |
| 573 | 573 | |
| 574 | 574 | |
| 575 | - /** |
|
| 576 | - * Sets description |
|
| 577 | - * |
|
| 578 | - * @param string $description |
|
| 579 | - * @throws \EE_Error |
|
| 580 | - */ |
|
| 575 | + /** |
|
| 576 | + * Sets description |
|
| 577 | + * |
|
| 578 | + * @param string $description |
|
| 579 | + * @throws \EE_Error |
|
| 580 | + */ |
|
| 581 | 581 | public function set_description( $description ) { |
| 582 | 582 | $this->set( 'TKT_description', $description ); |
| 583 | 583 | } |
| 584 | 584 | |
| 585 | 585 | |
| 586 | 586 | |
| 587 | - /** |
|
| 588 | - * Gets start_date |
|
| 589 | - * |
|
| 590 | - * @param string $dt_frmt |
|
| 591 | - * @param string $tm_frmt |
|
| 592 | - * @return string |
|
| 593 | - * @throws \EE_Error |
|
| 594 | - */ |
|
| 587 | + /** |
|
| 588 | + * Gets start_date |
|
| 589 | + * |
|
| 590 | + * @param string $dt_frmt |
|
| 591 | + * @param string $tm_frmt |
|
| 592 | + * @return string |
|
| 593 | + * @throws \EE_Error |
|
| 594 | + */ |
|
| 595 | 595 | public function start_date( $dt_frmt = '', $tm_frmt = '' ) { |
| 596 | 596 | return $this->_get_datetime( 'TKT_start_date', $dt_frmt, $tm_frmt ); |
| 597 | 597 | } |
| 598 | 598 | |
| 599 | 599 | |
| 600 | 600 | |
| 601 | - /** |
|
| 602 | - * Sets start_date |
|
| 603 | - * |
|
| 604 | - * @param string $start_date |
|
| 605 | - * @return void |
|
| 606 | - * @throws \EE_Error |
|
| 607 | - */ |
|
| 601 | + /** |
|
| 602 | + * Sets start_date |
|
| 603 | + * |
|
| 604 | + * @param string $start_date |
|
| 605 | + * @return void |
|
| 606 | + * @throws \EE_Error |
|
| 607 | + */ |
|
| 608 | 608 | public function set_start_date( $start_date ) { |
| 609 | 609 | $this->_set_date_time( 'B', $start_date, 'TKT_start_date' ); |
| 610 | 610 | } |
| 611 | 611 | |
| 612 | 612 | |
| 613 | 613 | |
| 614 | - /** |
|
| 615 | - * Gets end_date |
|
| 616 | - * |
|
| 617 | - * @param string $dt_frmt |
|
| 618 | - * @param string $tm_frmt |
|
| 619 | - * @return string |
|
| 620 | - * @throws \EE_Error |
|
| 621 | - */ |
|
| 614 | + /** |
|
| 615 | + * Gets end_date |
|
| 616 | + * |
|
| 617 | + * @param string $dt_frmt |
|
| 618 | + * @param string $tm_frmt |
|
| 619 | + * @return string |
|
| 620 | + * @throws \EE_Error |
|
| 621 | + */ |
|
| 622 | 622 | public function end_date( $dt_frmt = '', $tm_frmt = '' ) { |
| 623 | 623 | return $this->_get_datetime( 'TKT_end_date', $dt_frmt, $tm_frmt ); |
| 624 | 624 | } |
| 625 | 625 | |
| 626 | 626 | |
| 627 | 627 | |
| 628 | - /** |
|
| 629 | - * Sets end_date |
|
| 630 | - * |
|
| 631 | - * @param string $end_date |
|
| 632 | - * @return void |
|
| 633 | - * @throws \EE_Error |
|
| 634 | - */ |
|
| 628 | + /** |
|
| 629 | + * Sets end_date |
|
| 630 | + * |
|
| 631 | + * @param string $end_date |
|
| 632 | + * @return void |
|
| 633 | + * @throws \EE_Error |
|
| 634 | + */ |
|
| 635 | 635 | public function set_end_date( $end_date ) { |
| 636 | 636 | $this->_set_date_time( 'B', $end_date, 'TKT_end_date' ); |
| 637 | 637 | } |
| 638 | 638 | |
| 639 | 639 | |
| 640 | 640 | |
| 641 | - /** |
|
| 642 | - * Sets sell until time |
|
| 643 | - * |
|
| 644 | - * @since 4.5.0 |
|
| 645 | - * @param string $time a string representation of the sell until time (ex 9am or 7:30pm) |
|
| 646 | - * @throws \EE_Error |
|
| 647 | - */ |
|
| 641 | + /** |
|
| 642 | + * Sets sell until time |
|
| 643 | + * |
|
| 644 | + * @since 4.5.0 |
|
| 645 | + * @param string $time a string representation of the sell until time (ex 9am or 7:30pm) |
|
| 646 | + * @throws \EE_Error |
|
| 647 | + */ |
|
| 648 | 648 | public function set_end_time( $time ) { |
| 649 | 649 | $this->_set_time_for( $time, 'TKT_end_date' ); |
| 650 | 650 | } |
| 651 | 651 | |
| 652 | 652 | |
| 653 | 653 | |
| 654 | - /** |
|
| 655 | - * Sets min |
|
| 656 | - * |
|
| 657 | - * @param int $min |
|
| 658 | - * @return void |
|
| 659 | - * @throws \EE_Error |
|
| 660 | - */ |
|
| 654 | + /** |
|
| 655 | + * Sets min |
|
| 656 | + * |
|
| 657 | + * @param int $min |
|
| 658 | + * @return void |
|
| 659 | + * @throws \EE_Error |
|
| 660 | + */ |
|
| 661 | 661 | public function set_min( $min ) { |
| 662 | 662 | $this->set( 'TKT_min', $min ); |
| 663 | 663 | } |
| 664 | 664 | |
| 665 | 665 | |
| 666 | 666 | |
| 667 | - /** |
|
| 668 | - * Gets max |
|
| 669 | - * |
|
| 670 | - * @return int |
|
| 671 | - * @throws \EE_Error |
|
| 672 | - */ |
|
| 667 | + /** |
|
| 668 | + * Gets max |
|
| 669 | + * |
|
| 670 | + * @return int |
|
| 671 | + * @throws \EE_Error |
|
| 672 | + */ |
|
| 673 | 673 | public function max() { |
| 674 | 674 | return $this->get( 'TKT_max' ); |
| 675 | 675 | } |
| 676 | 676 | |
| 677 | 677 | |
| 678 | 678 | |
| 679 | - /** |
|
| 680 | - * Sets max |
|
| 681 | - * |
|
| 682 | - * @param int $max |
|
| 683 | - * @return void |
|
| 684 | - * @throws \EE_Error |
|
| 685 | - */ |
|
| 679 | + /** |
|
| 680 | + * Sets max |
|
| 681 | + * |
|
| 682 | + * @param int $max |
|
| 683 | + * @return void |
|
| 684 | + * @throws \EE_Error |
|
| 685 | + */ |
|
| 686 | 686 | public function set_max( $max ) { |
| 687 | 687 | $this->set( 'TKT_max', $max ); |
| 688 | 688 | } |
| 689 | 689 | |
| 690 | 690 | |
| 691 | 691 | |
| 692 | - /** |
|
| 693 | - * Sets price |
|
| 694 | - * |
|
| 695 | - * @param float $price |
|
| 696 | - * @return void |
|
| 697 | - * @throws \EE_Error |
|
| 698 | - */ |
|
| 692 | + /** |
|
| 693 | + * Sets price |
|
| 694 | + * |
|
| 695 | + * @param float $price |
|
| 696 | + * @return void |
|
| 697 | + * @throws \EE_Error |
|
| 698 | + */ |
|
| 699 | 699 | public function set_price( $price ) { |
| 700 | 700 | $this->set( 'TKT_price', $price ); |
| 701 | 701 | } |
| 702 | 702 | |
| 703 | 703 | |
| 704 | 704 | |
| 705 | - /** |
|
| 706 | - * Gets sold |
|
| 707 | - * |
|
| 708 | - * @return int |
|
| 709 | - * @throws \EE_Error |
|
| 710 | - */ |
|
| 705 | + /** |
|
| 706 | + * Gets sold |
|
| 707 | + * |
|
| 708 | + * @return int |
|
| 709 | + * @throws \EE_Error |
|
| 710 | + */ |
|
| 711 | 711 | public function sold() { |
| 712 | 712 | return $this->get_raw( 'TKT_sold' ); |
| 713 | 713 | } |
| 714 | 714 | |
| 715 | 715 | |
| 716 | 716 | |
| 717 | - /** |
|
| 718 | - * Sets sold |
|
| 719 | - * |
|
| 720 | - * @param int $sold |
|
| 721 | - * @return void |
|
| 722 | - * @throws \EE_Error |
|
| 723 | - */ |
|
| 717 | + /** |
|
| 718 | + * Sets sold |
|
| 719 | + * |
|
| 720 | + * @param int $sold |
|
| 721 | + * @return void |
|
| 722 | + * @throws \EE_Error |
|
| 723 | + */ |
|
| 724 | 724 | public function set_sold( $sold ) { |
| 725 | 725 | // sold can not go below zero |
| 726 | 726 | $sold = max( 0, $sold ); |
@@ -729,13 +729,13 @@ discard block |
||
| 729 | 729 | |
| 730 | 730 | |
| 731 | 731 | |
| 732 | - /** |
|
| 733 | - * increments sold by amount passed by $qty |
|
| 734 | - * |
|
| 735 | - * @param int $qty |
|
| 736 | - * @return void |
|
| 737 | - * @throws \EE_Error |
|
| 738 | - */ |
|
| 732 | + /** |
|
| 733 | + * increments sold by amount passed by $qty |
|
| 734 | + * |
|
| 735 | + * @param int $qty |
|
| 736 | + * @return void |
|
| 737 | + * @throws \EE_Error |
|
| 738 | + */ |
|
| 739 | 739 | public function increase_sold( $qty = 1 ) { |
| 740 | 740 | $sold = $this->sold() + $qty; |
| 741 | 741 | // remove ticket reservation, but don't adjust datetime reservations, because that will happen |
@@ -747,13 +747,13 @@ discard block |
||
| 747 | 747 | |
| 748 | 748 | |
| 749 | 749 | |
| 750 | - /** |
|
| 751 | - * Increases sold on related datetimes |
|
| 752 | - * |
|
| 753 | - * @param int $qty |
|
| 754 | - * @return void |
|
| 755 | - * @throws \EE_Error |
|
| 756 | - */ |
|
| 750 | + /** |
|
| 751 | + * Increases sold on related datetimes |
|
| 752 | + * |
|
| 753 | + * @param int $qty |
|
| 754 | + * @return void |
|
| 755 | + * @throws \EE_Error |
|
| 756 | + */ |
|
| 757 | 757 | protected function _increase_sold_for_datetimes( $qty = 1 ) { |
| 758 | 758 | $datetimes = $this->datetimes(); |
| 759 | 759 | if ( is_array( $datetimes ) ) { |
@@ -768,13 +768,13 @@ discard block |
||
| 768 | 768 | |
| 769 | 769 | |
| 770 | 770 | |
| 771 | - /** |
|
| 772 | - * decrements (subtracts) sold by amount passed by $qty |
|
| 773 | - * |
|
| 774 | - * @param int $qty |
|
| 775 | - * @return void |
|
| 776 | - * @throws \EE_Error |
|
| 777 | - */ |
|
| 771 | + /** |
|
| 772 | + * decrements (subtracts) sold by amount passed by $qty |
|
| 773 | + * |
|
| 774 | + * @param int $qty |
|
| 775 | + * @return void |
|
| 776 | + * @throws \EE_Error |
|
| 777 | + */ |
|
| 778 | 778 | public function decrease_sold( $qty = 1 ) { |
| 779 | 779 | $sold = $this->sold() - $qty; |
| 780 | 780 | $this->_decrease_sold_for_datetimes( $qty ); |
@@ -783,13 +783,13 @@ discard block |
||
| 783 | 783 | |
| 784 | 784 | |
| 785 | 785 | |
| 786 | - /** |
|
| 787 | - * Decreases sold on related datetimes |
|
| 788 | - * |
|
| 789 | - * @param int $qty |
|
| 790 | - * @return void |
|
| 791 | - * @throws \EE_Error |
|
| 792 | - */ |
|
| 786 | + /** |
|
| 787 | + * Decreases sold on related datetimes |
|
| 788 | + * |
|
| 789 | + * @param int $qty |
|
| 790 | + * @return void |
|
| 791 | + * @throws \EE_Error |
|
| 792 | + */ |
|
| 793 | 793 | protected function _decrease_sold_for_datetimes( $qty = 1 ) { |
| 794 | 794 | $datetimes = $this->datetimes(); |
| 795 | 795 | if ( is_array( $datetimes ) ) { |
@@ -804,25 +804,25 @@ discard block |
||
| 804 | 804 | |
| 805 | 805 | |
| 806 | 806 | |
| 807 | - /** |
|
| 808 | - * Gets qty of reserved tickets |
|
| 809 | - * |
|
| 810 | - * @return int |
|
| 811 | - * @throws \EE_Error |
|
| 812 | - */ |
|
| 807 | + /** |
|
| 808 | + * Gets qty of reserved tickets |
|
| 809 | + * |
|
| 810 | + * @return int |
|
| 811 | + * @throws \EE_Error |
|
| 812 | + */ |
|
| 813 | 813 | public function reserved() { |
| 814 | 814 | return $this->get_raw( 'TKT_reserved' ); |
| 815 | 815 | } |
| 816 | 816 | |
| 817 | 817 | |
| 818 | 818 | |
| 819 | - /** |
|
| 820 | - * Sets reserved |
|
| 821 | - * |
|
| 822 | - * @param int $reserved |
|
| 823 | - * @return void |
|
| 824 | - * @throws \EE_Error |
|
| 825 | - */ |
|
| 819 | + /** |
|
| 820 | + * Sets reserved |
|
| 821 | + * |
|
| 822 | + * @param int $reserved |
|
| 823 | + * @return void |
|
| 824 | + * @throws \EE_Error |
|
| 825 | + */ |
|
| 826 | 826 | public function set_reserved( $reserved ) { |
| 827 | 827 | // reserved can not go below zero |
| 828 | 828 | $reserved = max( 0, (int) $reserved ); |
@@ -831,13 +831,13 @@ discard block |
||
| 831 | 831 | |
| 832 | 832 | |
| 833 | 833 | |
| 834 | - /** |
|
| 835 | - * increments reserved by amount passed by $qty |
|
| 836 | - * |
|
| 837 | - * @param int $qty |
|
| 838 | - * @return void |
|
| 839 | - * @throws \EE_Error |
|
| 840 | - */ |
|
| 834 | + /** |
|
| 835 | + * increments reserved by amount passed by $qty |
|
| 836 | + * |
|
| 837 | + * @param int $qty |
|
| 838 | + * @return void |
|
| 839 | + * @throws \EE_Error |
|
| 840 | + */ |
|
| 841 | 841 | public function increase_reserved( $qty = 1 ) { |
| 842 | 842 | $qty = absint( $qty ); |
| 843 | 843 | $reserved = $this->reserved() + $qty; |
@@ -847,13 +847,13 @@ discard block |
||
| 847 | 847 | |
| 848 | 848 | |
| 849 | 849 | |
| 850 | - /** |
|
| 851 | - * Increases sold on related datetimes |
|
| 852 | - * |
|
| 853 | - * @param int $qty |
|
| 854 | - * @return void |
|
| 855 | - * @throws \EE_Error |
|
| 856 | - */ |
|
| 850 | + /** |
|
| 851 | + * Increases sold on related datetimes |
|
| 852 | + * |
|
| 853 | + * @param int $qty |
|
| 854 | + * @return void |
|
| 855 | + * @throws \EE_Error |
|
| 856 | + */ |
|
| 857 | 857 | protected function _increase_reserved_for_datetimes( $qty = 1 ) { |
| 858 | 858 | $datetimes = $this->datetimes(); |
| 859 | 859 | if ( is_array( $datetimes ) ) { |
@@ -868,14 +868,14 @@ discard block |
||
| 868 | 868 | |
| 869 | 869 | |
| 870 | 870 | |
| 871 | - /** |
|
| 872 | - * decrements (subtracts) reserved by amount passed by $qty |
|
| 873 | - * |
|
| 874 | - * @param int $qty |
|
| 875 | - * @param bool $adjust_datetimes |
|
| 876 | - * @return void |
|
| 877 | - * @throws \EE_Error |
|
| 878 | - */ |
|
| 871 | + /** |
|
| 872 | + * decrements (subtracts) reserved by amount passed by $qty |
|
| 873 | + * |
|
| 874 | + * @param int $qty |
|
| 875 | + * @param bool $adjust_datetimes |
|
| 876 | + * @return void |
|
| 877 | + * @throws \EE_Error |
|
| 878 | + */ |
|
| 879 | 879 | public function decrease_reserved( $qty = 1, $adjust_datetimes = true ) { |
| 880 | 880 | $reserved = $this->reserved() - absint( $qty ); |
| 881 | 881 | if ( $adjust_datetimes ) { |
@@ -886,13 +886,13 @@ discard block |
||
| 886 | 886 | |
| 887 | 887 | |
| 888 | 888 | |
| 889 | - /** |
|
| 890 | - * Increases sold on related datetimes |
|
| 891 | - * |
|
| 892 | - * @param int $qty |
|
| 893 | - * @return void |
|
| 894 | - * @throws \EE_Error |
|
| 895 | - */ |
|
| 889 | + /** |
|
| 890 | + * Increases sold on related datetimes |
|
| 891 | + * |
|
| 892 | + * @param int $qty |
|
| 893 | + * @return void |
|
| 894 | + * @throws \EE_Error |
|
| 895 | + */ |
|
| 896 | 896 | protected function _decrease_reserved_for_datetimes( $qty = 1 ) { |
| 897 | 897 | $datetimes = $this->datetimes(); |
| 898 | 898 | if ( is_array( $datetimes ) ) { |
@@ -907,18 +907,18 @@ discard block |
||
| 907 | 907 | |
| 908 | 908 | |
| 909 | 909 | |
| 910 | - /** |
|
| 911 | - * Gets ticket quantity |
|
| 912 | - * |
|
| 913 | - * @param string $context ticket quantity is somewhat subjective depending on the exact information sought |
|
| 914 | - * therefore $context can be one of three values: '', 'reg_limit', or 'saleable' |
|
| 915 | - * '' (default) quantity is the actual db value for TKT_qty, unaffected by other objects |
|
| 916 | - * REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes |
|
| 917 | - * SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and |
|
| 918 | - * is therefore the truest measure of tickets that can be purchased at the moment |
|
| 919 | - * @return int |
|
| 920 | - * @throws \EE_Error |
|
| 921 | - */ |
|
| 910 | + /** |
|
| 911 | + * Gets ticket quantity |
|
| 912 | + * |
|
| 913 | + * @param string $context ticket quantity is somewhat subjective depending on the exact information sought |
|
| 914 | + * therefore $context can be one of three values: '', 'reg_limit', or 'saleable' |
|
| 915 | + * '' (default) quantity is the actual db value for TKT_qty, unaffected by other objects |
|
| 916 | + * REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes |
|
| 917 | + * SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and |
|
| 918 | + * is therefore the truest measure of tickets that can be purchased at the moment |
|
| 919 | + * @return int |
|
| 920 | + * @throws \EE_Error |
|
| 921 | + */ |
|
| 922 | 922 | public function qty( $context = '' ) { |
| 923 | 923 | switch ( $context ) { |
| 924 | 924 | case 'reg_limit' : |
@@ -932,19 +932,19 @@ discard block |
||
| 932 | 932 | |
| 933 | 933 | |
| 934 | 934 | |
| 935 | - /** |
|
| 936 | - * Gets ticket quantity |
|
| 937 | - * |
|
| 938 | - * @param string $context ticket quantity is somewhat subjective depending on the exact information sought |
|
| 939 | - * therefore $context can be one of two values: 'reg_limit', or 'saleable' |
|
| 940 | - * REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes |
|
| 941 | - * SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and |
|
| 942 | - * is therefore the truest measure of tickets that can be purchased at the moment |
|
| 943 | - * @param int $DTT_ID the primary key for a particular datetime. |
|
| 944 | - * set to 0 for all related datetimes |
|
| 945 | - * @return int |
|
| 946 | - * @throws \EE_Error |
|
| 947 | - */ |
|
| 935 | + /** |
|
| 936 | + * Gets ticket quantity |
|
| 937 | + * |
|
| 938 | + * @param string $context ticket quantity is somewhat subjective depending on the exact information sought |
|
| 939 | + * therefore $context can be one of two values: 'reg_limit', or 'saleable' |
|
| 940 | + * REG LIMIT: caps qty based on DTT_reg_limit for ALL related datetimes |
|
| 941 | + * SALEABLE: also considers datetime sold and returns zero if ANY DTT is sold out, and |
|
| 942 | + * is therefore the truest measure of tickets that can be purchased at the moment |
|
| 943 | + * @param int $DTT_ID the primary key for a particular datetime. |
|
| 944 | + * set to 0 for all related datetimes |
|
| 945 | + * @return int |
|
| 946 | + * @throws \EE_Error |
|
| 947 | + */ |
|
| 948 | 948 | public function real_quantity_on_ticket( $context = 'reg_limit', $DTT_ID = 0 ) { |
| 949 | 949 | $raw = $this->get_raw( 'TKT_qty' ); |
| 950 | 950 | // return immediately if it's zero |
@@ -1027,212 +1027,212 @@ discard block |
||
| 1027 | 1027 | |
| 1028 | 1028 | |
| 1029 | 1029 | |
| 1030 | - /** |
|
| 1031 | - * Gets uses |
|
| 1032 | - * |
|
| 1033 | - * @return int |
|
| 1034 | - * @throws \EE_Error |
|
| 1035 | - */ |
|
| 1030 | + /** |
|
| 1031 | + * Gets uses |
|
| 1032 | + * |
|
| 1033 | + * @return int |
|
| 1034 | + * @throws \EE_Error |
|
| 1035 | + */ |
|
| 1036 | 1036 | public function uses() { |
| 1037 | 1037 | return $this->get( 'TKT_uses' ); |
| 1038 | 1038 | } |
| 1039 | 1039 | |
| 1040 | 1040 | |
| 1041 | 1041 | |
| 1042 | - /** |
|
| 1043 | - * Sets uses |
|
| 1044 | - * |
|
| 1045 | - * @param int $uses |
|
| 1046 | - * @return void |
|
| 1047 | - * @throws \EE_Error |
|
| 1048 | - */ |
|
| 1042 | + /** |
|
| 1043 | + * Sets uses |
|
| 1044 | + * |
|
| 1045 | + * @param int $uses |
|
| 1046 | + * @return void |
|
| 1047 | + * @throws \EE_Error |
|
| 1048 | + */ |
|
| 1049 | 1049 | public function set_uses( $uses ) { |
| 1050 | 1050 | $this->set( 'TKT_uses', $uses ); |
| 1051 | 1051 | } |
| 1052 | 1052 | |
| 1053 | 1053 | |
| 1054 | 1054 | |
| 1055 | - /** |
|
| 1056 | - * returns whether ticket is required or not. |
|
| 1057 | - * |
|
| 1058 | - * @return boolean |
|
| 1059 | - * @throws \EE_Error |
|
| 1060 | - */ |
|
| 1055 | + /** |
|
| 1056 | + * returns whether ticket is required or not. |
|
| 1057 | + * |
|
| 1058 | + * @return boolean |
|
| 1059 | + * @throws \EE_Error |
|
| 1060 | + */ |
|
| 1061 | 1061 | public function required() { |
| 1062 | 1062 | return $this->get( 'TKT_required' ); |
| 1063 | 1063 | } |
| 1064 | 1064 | |
| 1065 | 1065 | |
| 1066 | 1066 | |
| 1067 | - /** |
|
| 1068 | - * sets the TKT_required property |
|
| 1069 | - * |
|
| 1070 | - * @param boolean $required |
|
| 1071 | - * @return void |
|
| 1072 | - * @throws \EE_Error |
|
| 1073 | - */ |
|
| 1067 | + /** |
|
| 1068 | + * sets the TKT_required property |
|
| 1069 | + * |
|
| 1070 | + * @param boolean $required |
|
| 1071 | + * @return void |
|
| 1072 | + * @throws \EE_Error |
|
| 1073 | + */ |
|
| 1074 | 1074 | public function set_required( $required ) { |
| 1075 | 1075 | $this->set( 'TKT_required', $required ); |
| 1076 | 1076 | } |
| 1077 | 1077 | |
| 1078 | 1078 | |
| 1079 | 1079 | |
| 1080 | - /** |
|
| 1081 | - * Gets taxable |
|
| 1082 | - * |
|
| 1083 | - * @return boolean |
|
| 1084 | - * @throws \EE_Error |
|
| 1085 | - */ |
|
| 1080 | + /** |
|
| 1081 | + * Gets taxable |
|
| 1082 | + * |
|
| 1083 | + * @return boolean |
|
| 1084 | + * @throws \EE_Error |
|
| 1085 | + */ |
|
| 1086 | 1086 | public function taxable() { |
| 1087 | 1087 | return $this->get( 'TKT_taxable' ); |
| 1088 | 1088 | } |
| 1089 | 1089 | |
| 1090 | 1090 | |
| 1091 | 1091 | |
| 1092 | - /** |
|
| 1093 | - * Sets taxable |
|
| 1094 | - * |
|
| 1095 | - * @param boolean $taxable |
|
| 1096 | - * @return void |
|
| 1097 | - * @throws \EE_Error |
|
| 1098 | - */ |
|
| 1092 | + /** |
|
| 1093 | + * Sets taxable |
|
| 1094 | + * |
|
| 1095 | + * @param boolean $taxable |
|
| 1096 | + * @return void |
|
| 1097 | + * @throws \EE_Error |
|
| 1098 | + */ |
|
| 1099 | 1099 | public function set_taxable( $taxable ) { |
| 1100 | 1100 | $this->set( 'TKT_taxable', $taxable ); |
| 1101 | 1101 | } |
| 1102 | 1102 | |
| 1103 | 1103 | |
| 1104 | 1104 | |
| 1105 | - /** |
|
| 1106 | - * Gets is_default |
|
| 1107 | - * |
|
| 1108 | - * @return boolean |
|
| 1109 | - * @throws \EE_Error |
|
| 1110 | - */ |
|
| 1105 | + /** |
|
| 1106 | + * Gets is_default |
|
| 1107 | + * |
|
| 1108 | + * @return boolean |
|
| 1109 | + * @throws \EE_Error |
|
| 1110 | + */ |
|
| 1111 | 1111 | public function is_default() { |
| 1112 | 1112 | return $this->get( 'TKT_is_default' ); |
| 1113 | 1113 | } |
| 1114 | 1114 | |
| 1115 | 1115 | |
| 1116 | 1116 | |
| 1117 | - /** |
|
| 1118 | - * Sets is_default |
|
| 1119 | - * |
|
| 1120 | - * @param boolean $is_default |
|
| 1121 | - * @return void |
|
| 1122 | - * @throws \EE_Error |
|
| 1123 | - */ |
|
| 1117 | + /** |
|
| 1118 | + * Sets is_default |
|
| 1119 | + * |
|
| 1120 | + * @param boolean $is_default |
|
| 1121 | + * @return void |
|
| 1122 | + * @throws \EE_Error |
|
| 1123 | + */ |
|
| 1124 | 1124 | public function set_is_default( $is_default ) { |
| 1125 | 1125 | $this->set( 'TKT_is_default', $is_default ); |
| 1126 | 1126 | } |
| 1127 | 1127 | |
| 1128 | 1128 | |
| 1129 | 1129 | |
| 1130 | - /** |
|
| 1131 | - * Gets order |
|
| 1132 | - * |
|
| 1133 | - * @return int |
|
| 1134 | - * @throws \EE_Error |
|
| 1135 | - */ |
|
| 1130 | + /** |
|
| 1131 | + * Gets order |
|
| 1132 | + * |
|
| 1133 | + * @return int |
|
| 1134 | + * @throws \EE_Error |
|
| 1135 | + */ |
|
| 1136 | 1136 | public function order() { |
| 1137 | 1137 | return $this->get( 'TKT_order' ); |
| 1138 | 1138 | } |
| 1139 | 1139 | |
| 1140 | 1140 | |
| 1141 | 1141 | |
| 1142 | - /** |
|
| 1143 | - * Sets order |
|
| 1144 | - * |
|
| 1145 | - * @param int $order |
|
| 1146 | - * @return void |
|
| 1147 | - * @throws \EE_Error |
|
| 1148 | - */ |
|
| 1142 | + /** |
|
| 1143 | + * Sets order |
|
| 1144 | + * |
|
| 1145 | + * @param int $order |
|
| 1146 | + * @return void |
|
| 1147 | + * @throws \EE_Error |
|
| 1148 | + */ |
|
| 1149 | 1149 | public function set_order( $order ) { |
| 1150 | 1150 | $this->set( 'TKT_order', $order ); |
| 1151 | 1151 | } |
| 1152 | 1152 | |
| 1153 | 1153 | |
| 1154 | 1154 | |
| 1155 | - /** |
|
| 1156 | - * Gets row |
|
| 1157 | - * |
|
| 1158 | - * @return int |
|
| 1159 | - * @throws \EE_Error |
|
| 1160 | - */ |
|
| 1155 | + /** |
|
| 1156 | + * Gets row |
|
| 1157 | + * |
|
| 1158 | + * @return int |
|
| 1159 | + * @throws \EE_Error |
|
| 1160 | + */ |
|
| 1161 | 1161 | public function row() { |
| 1162 | 1162 | return $this->get( 'TKT_row' ); |
| 1163 | 1163 | } |
| 1164 | 1164 | |
| 1165 | 1165 | |
| 1166 | 1166 | |
| 1167 | - /** |
|
| 1168 | - * Sets row |
|
| 1169 | - * |
|
| 1170 | - * @param int $row |
|
| 1171 | - * @return void |
|
| 1172 | - * @throws \EE_Error |
|
| 1173 | - */ |
|
| 1167 | + /** |
|
| 1168 | + * Sets row |
|
| 1169 | + * |
|
| 1170 | + * @param int $row |
|
| 1171 | + * @return void |
|
| 1172 | + * @throws \EE_Error |
|
| 1173 | + */ |
|
| 1174 | 1174 | public function set_row( $row ) { |
| 1175 | 1175 | $this->set( 'TKT_row', $row ); |
| 1176 | 1176 | } |
| 1177 | 1177 | |
| 1178 | 1178 | |
| 1179 | 1179 | |
| 1180 | - /** |
|
| 1181 | - * Gets deleted |
|
| 1182 | - * |
|
| 1183 | - * @return boolean |
|
| 1184 | - * @throws \EE_Error |
|
| 1185 | - */ |
|
| 1180 | + /** |
|
| 1181 | + * Gets deleted |
|
| 1182 | + * |
|
| 1183 | + * @return boolean |
|
| 1184 | + * @throws \EE_Error |
|
| 1185 | + */ |
|
| 1186 | 1186 | public function deleted() { |
| 1187 | 1187 | return $this->get( 'TKT_deleted' ); |
| 1188 | 1188 | } |
| 1189 | 1189 | |
| 1190 | 1190 | |
| 1191 | 1191 | |
| 1192 | - /** |
|
| 1193 | - * Sets deleted |
|
| 1194 | - * |
|
| 1195 | - * @param boolean $deleted |
|
| 1196 | - * @return void |
|
| 1197 | - * @throws \EE_Error |
|
| 1198 | - */ |
|
| 1192 | + /** |
|
| 1193 | + * Sets deleted |
|
| 1194 | + * |
|
| 1195 | + * @param boolean $deleted |
|
| 1196 | + * @return void |
|
| 1197 | + * @throws \EE_Error |
|
| 1198 | + */ |
|
| 1199 | 1199 | public function set_deleted( $deleted ) { |
| 1200 | 1200 | $this->set( 'TKT_deleted', $deleted ); |
| 1201 | 1201 | } |
| 1202 | 1202 | |
| 1203 | 1203 | |
| 1204 | 1204 | |
| 1205 | - /** |
|
| 1206 | - * Gets parent |
|
| 1207 | - * |
|
| 1208 | - * @return int |
|
| 1209 | - * @throws \EE_Error |
|
| 1210 | - */ |
|
| 1205 | + /** |
|
| 1206 | + * Gets parent |
|
| 1207 | + * |
|
| 1208 | + * @return int |
|
| 1209 | + * @throws \EE_Error |
|
| 1210 | + */ |
|
| 1211 | 1211 | public function parent_ID() { |
| 1212 | 1212 | return $this->get( 'TKT_parent' ); |
| 1213 | 1213 | } |
| 1214 | 1214 | |
| 1215 | 1215 | |
| 1216 | 1216 | |
| 1217 | - /** |
|
| 1218 | - * Sets parent |
|
| 1219 | - * |
|
| 1220 | - * @param int $parent |
|
| 1221 | - * @return void |
|
| 1222 | - * @throws \EE_Error |
|
| 1223 | - */ |
|
| 1217 | + /** |
|
| 1218 | + * Sets parent |
|
| 1219 | + * |
|
| 1220 | + * @param int $parent |
|
| 1221 | + * @return void |
|
| 1222 | + * @throws \EE_Error |
|
| 1223 | + */ |
|
| 1224 | 1224 | public function set_parent_ID( $parent ) { |
| 1225 | 1225 | $this->set( 'TKT_parent', $parent ); |
| 1226 | 1226 | } |
| 1227 | 1227 | |
| 1228 | 1228 | |
| 1229 | 1229 | |
| 1230 | - /** |
|
| 1231 | - * Gets a string which is handy for showing in gateways etc that describes the ticket. |
|
| 1232 | - * |
|
| 1233 | - * @return string |
|
| 1234 | - * @throws \EE_Error |
|
| 1235 | - */ |
|
| 1230 | + /** |
|
| 1231 | + * Gets a string which is handy for showing in gateways etc that describes the ticket. |
|
| 1232 | + * |
|
| 1233 | + * @return string |
|
| 1234 | + * @throws \EE_Error |
|
| 1235 | + */ |
|
| 1236 | 1236 | public function name_and_info() { |
| 1237 | 1237 | $times = array(); |
| 1238 | 1238 | foreach ( $this->datetimes() as $datetime ) { |
@@ -1243,67 +1243,67 @@ discard block |
||
| 1243 | 1243 | |
| 1244 | 1244 | |
| 1245 | 1245 | |
| 1246 | - /** |
|
| 1247 | - * Gets name |
|
| 1248 | - * |
|
| 1249 | - * @return string |
|
| 1250 | - * @throws \EE_Error |
|
| 1251 | - */ |
|
| 1246 | + /** |
|
| 1247 | + * Gets name |
|
| 1248 | + * |
|
| 1249 | + * @return string |
|
| 1250 | + * @throws \EE_Error |
|
| 1251 | + */ |
|
| 1252 | 1252 | public function name() { |
| 1253 | 1253 | return $this->get( 'TKT_name' ); |
| 1254 | 1254 | } |
| 1255 | 1255 | |
| 1256 | 1256 | |
| 1257 | 1257 | |
| 1258 | - /** |
|
| 1259 | - * Gets price |
|
| 1260 | - * |
|
| 1261 | - * @return float |
|
| 1262 | - * @throws \EE_Error |
|
| 1263 | - */ |
|
| 1258 | + /** |
|
| 1259 | + * Gets price |
|
| 1260 | + * |
|
| 1261 | + * @return float |
|
| 1262 | + * @throws \EE_Error |
|
| 1263 | + */ |
|
| 1264 | 1264 | public function price() { |
| 1265 | 1265 | return $this->get( 'TKT_price' ); |
| 1266 | 1266 | } |
| 1267 | 1267 | |
| 1268 | 1268 | |
| 1269 | 1269 | |
| 1270 | - /** |
|
| 1271 | - * Gets all the registrations for this ticket |
|
| 1272 | - * |
|
| 1273 | - * @param array $query_params like EEM_Base::get_all's |
|
| 1274 | - * @return EE_Registration[]|EE_Base_Class[] |
|
| 1275 | - * @throws \EE_Error |
|
| 1276 | - */ |
|
| 1270 | + /** |
|
| 1271 | + * Gets all the registrations for this ticket |
|
| 1272 | + * |
|
| 1273 | + * @param array $query_params like EEM_Base::get_all's |
|
| 1274 | + * @return EE_Registration[]|EE_Base_Class[] |
|
| 1275 | + * @throws \EE_Error |
|
| 1276 | + */ |
|
| 1277 | 1277 | public function registrations( $query_params = array() ) { |
| 1278 | 1278 | return $this->get_many_related( 'Registration', $query_params ); |
| 1279 | 1279 | } |
| 1280 | 1280 | |
| 1281 | 1281 | |
| 1282 | 1282 | |
| 1283 | - /** |
|
| 1284 | - * Updates the TKT_sold attribute (and saves) based on the number of APPROVED registrations for this ticket. |
|
| 1285 | - * into account |
|
| 1286 | - * |
|
| 1287 | - * @return int |
|
| 1288 | - * @throws \EE_Error |
|
| 1289 | - */ |
|
| 1283 | + /** |
|
| 1284 | + * Updates the TKT_sold attribute (and saves) based on the number of APPROVED registrations for this ticket. |
|
| 1285 | + * into account |
|
| 1286 | + * |
|
| 1287 | + * @return int |
|
| 1288 | + * @throws \EE_Error |
|
| 1289 | + */ |
|
| 1290 | 1290 | public function update_tickets_sold() { |
| 1291 | - $count_regs_for_this_ticket = $this->count_registrations( |
|
| 1292 | - array( |
|
| 1293 | - array( |
|
| 1294 | - 'STS_ID' => EEM_Registration::status_id_approved, |
|
| 1295 | - 'REG_deleted' => 0, |
|
| 1296 | - ), |
|
| 1297 | - ) |
|
| 1298 | - ); |
|
| 1299 | - $sold = $this->sold(); |
|
| 1300 | - if ($count_regs_for_this_ticket > $sold) { |
|
| 1301 | - $this->increase_sold($count_regs_for_this_ticket - $sold); |
|
| 1302 | - $this->save(); |
|
| 1303 | - } else if ($count_regs_for_this_ticket < $sold) { |
|
| 1304 | - $this->decrease_sold($count_regs_for_this_ticket - $sold); |
|
| 1305 | - $this->save(); |
|
| 1306 | - } |
|
| 1291 | + $count_regs_for_this_ticket = $this->count_registrations( |
|
| 1292 | + array( |
|
| 1293 | + array( |
|
| 1294 | + 'STS_ID' => EEM_Registration::status_id_approved, |
|
| 1295 | + 'REG_deleted' => 0, |
|
| 1296 | + ), |
|
| 1297 | + ) |
|
| 1298 | + ); |
|
| 1299 | + $sold = $this->sold(); |
|
| 1300 | + if ($count_regs_for_this_ticket > $sold) { |
|
| 1301 | + $this->increase_sold($count_regs_for_this_ticket - $sold); |
|
| 1302 | + $this->save(); |
|
| 1303 | + } else if ($count_regs_for_this_ticket < $sold) { |
|
| 1304 | + $this->decrease_sold($count_regs_for_this_ticket - $sold); |
|
| 1305 | + $this->save(); |
|
| 1306 | + } |
|
| 1307 | 1307 | return $count_regs_for_this_ticket; |
| 1308 | 1308 | } |
| 1309 | 1309 | |
@@ -1331,21 +1331,21 @@ discard block |
||
| 1331 | 1331 | |
| 1332 | 1332 | |
| 1333 | 1333 | |
| 1334 | - /** |
|
| 1335 | - * Implementation of the EEI_Event_Relation interface method |
|
| 1336 | - * |
|
| 1337 | - * @see EEI_Event_Relation for comments |
|
| 1338 | - * @return EE_Event |
|
| 1339 | - * @throws \EE_Error |
|
| 1340 | - * @throws UnexpectedEntityException |
|
| 1341 | - */ |
|
| 1334 | + /** |
|
| 1335 | + * Implementation of the EEI_Event_Relation interface method |
|
| 1336 | + * |
|
| 1337 | + * @see EEI_Event_Relation for comments |
|
| 1338 | + * @return EE_Event |
|
| 1339 | + * @throws \EE_Error |
|
| 1340 | + * @throws UnexpectedEntityException |
|
| 1341 | + */ |
|
| 1342 | 1342 | public function get_related_event() { |
| 1343 | 1343 | //get one datetime to use for getting the event |
| 1344 | 1344 | $datetime = $this->first_datetime(); |
| 1345 | 1345 | if ( ! $datetime instanceof \EE_Datetime ) { |
| 1346 | 1346 | throw new UnexpectedEntityException( |
| 1347 | 1347 | $datetime, |
| 1348 | - 'EE_Datetime', |
|
| 1348 | + 'EE_Datetime', |
|
| 1349 | 1349 | sprintf( |
| 1350 | 1350 | __( 'The ticket (%s) is not associated with any valid datetimes.', 'event_espresso'), |
| 1351 | 1351 | $this->name() |
@@ -1356,7 +1356,7 @@ discard block |
||
| 1356 | 1356 | if ( ! $event instanceof \EE_Event ) { |
| 1357 | 1357 | throw new UnexpectedEntityException( |
| 1358 | 1358 | $event, |
| 1359 | - 'EE_Event', |
|
| 1359 | + 'EE_Event', |
|
| 1360 | 1360 | sprintf( |
| 1361 | 1361 | __( 'The ticket (%s) is not associated with a valid event.', 'event_espresso'), |
| 1362 | 1362 | $this->name() |
@@ -1368,14 +1368,14 @@ discard block |
||
| 1368 | 1368 | |
| 1369 | 1369 | |
| 1370 | 1370 | |
| 1371 | - /** |
|
| 1372 | - * Implementation of the EEI_Event_Relation interface method |
|
| 1373 | - * |
|
| 1374 | - * @see EEI_Event_Relation for comments |
|
| 1375 | - * @return string |
|
| 1376 | - * @throws UnexpectedEntityException |
|
| 1377 | - * @throws \EE_Error |
|
| 1378 | - */ |
|
| 1371 | + /** |
|
| 1372 | + * Implementation of the EEI_Event_Relation interface method |
|
| 1373 | + * |
|
| 1374 | + * @see EEI_Event_Relation for comments |
|
| 1375 | + * @return string |
|
| 1376 | + * @throws UnexpectedEntityException |
|
| 1377 | + * @throws \EE_Error |
|
| 1378 | + */ |
|
| 1379 | 1379 | public function get_event_name() { |
| 1380 | 1380 | $event = $this->get_related_event(); |
| 1381 | 1381 | return $event instanceof EE_Event ? $event->name() : ''; |
@@ -1383,28 +1383,28 @@ discard block |
||
| 1383 | 1383 | |
| 1384 | 1384 | |
| 1385 | 1385 | |
| 1386 | - /** |
|
| 1387 | - * Implementation of the EEI_Event_Relation interface method |
|
| 1388 | - * |
|
| 1389 | - * @see EEI_Event_Relation for comments |
|
| 1390 | - * @return int |
|
| 1391 | - * @throws UnexpectedEntityException |
|
| 1392 | - * @throws \EE_Error |
|
| 1393 | - */ |
|
| 1386 | + /** |
|
| 1387 | + * Implementation of the EEI_Event_Relation interface method |
|
| 1388 | + * |
|
| 1389 | + * @see EEI_Event_Relation for comments |
|
| 1390 | + * @return int |
|
| 1391 | + * @throws UnexpectedEntityException |
|
| 1392 | + * @throws \EE_Error |
|
| 1393 | + */ |
|
| 1394 | 1394 | public function get_event_ID() { |
| 1395 | 1395 | $event = $this->get_related_event(); |
| 1396 | 1396 | return $event instanceof EE_Event ? $event->ID() : 0; |
| 1397 | 1397 | } |
| 1398 | 1398 | |
| 1399 | 1399 | |
| 1400 | - /** |
|
| 1401 | - * This simply returns whether a ticket can be permanently deleted or not. |
|
| 1402 | - * The criteria for determining this is whether the ticket has any related registrations. |
|
| 1403 | - * If there are none then it can be permanently deleted. |
|
| 1404 | - * |
|
| 1405 | - * @return bool |
|
| 1406 | - */ |
|
| 1400 | + /** |
|
| 1401 | + * This simply returns whether a ticket can be permanently deleted or not. |
|
| 1402 | + * The criteria for determining this is whether the ticket has any related registrations. |
|
| 1403 | + * If there are none then it can be permanently deleted. |
|
| 1404 | + * |
|
| 1405 | + * @return bool |
|
| 1406 | + */ |
|
| 1407 | 1407 | public function is_permanently_deleteable() { |
| 1408 | - return $this->count_registrations() === 0; |
|
| 1409 | - } |
|
| 1408 | + return $this->count_registrations() === 0; |
|
| 1409 | + } |
|
| 1410 | 1410 | } //end EE_Ticket class |
@@ -15,2114 +15,2114 @@ |
||
| 15 | 15 | class espresso_events_Pricing_Hooks extends EE_Admin_Hooks |
| 16 | 16 | { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * This property is just used to hold the status of whether an event is currently being |
|
| 20 | - * created (true) or edited (false) |
|
| 21 | - * |
|
| 22 | - * @access protected |
|
| 23 | - * @var bool |
|
| 24 | - */ |
|
| 25 | - protected $_is_creating_event; |
|
| 26 | - |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * Used to contain the format strings for date and time that will be used for php date and |
|
| 30 | - * time. |
|
| 31 | - * Is set in the _set_hooks_properties() method. |
|
| 32 | - * |
|
| 33 | - * @var array |
|
| 34 | - */ |
|
| 35 | - protected $_date_format_strings; |
|
| 36 | - |
|
| 37 | - |
|
| 38 | - /** |
|
| 39 | - * @var string $_date_time_format |
|
| 40 | - */ |
|
| 41 | - protected $_date_time_format; |
|
| 42 | - |
|
| 43 | - |
|
| 44 | - |
|
| 45 | - /** |
|
| 46 | - * |
|
| 47 | - */ |
|
| 48 | - protected function _set_hooks_properties() |
|
| 49 | - { |
|
| 50 | - $this->_name = 'pricing'; |
|
| 51 | - //capability check |
|
| 52 | - if (! EE_Registry::instance()->CAP->current_user_can( |
|
| 53 | - 'ee_read_default_prices', |
|
| 54 | - 'advanced_ticket_datetime_metabox' |
|
| 55 | - )) { |
|
| 56 | - return; |
|
| 57 | - } |
|
| 58 | - $this->_setup_metaboxes(); |
|
| 59 | - $this->_set_date_time_formats(); |
|
| 60 | - $this->_validate_format_strings(); |
|
| 61 | - $this->_set_scripts_styles(); |
|
| 62 | - // commented out temporarily until logic is implemented in callback |
|
| 63 | - // add_action( |
|
| 64 | - // 'AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_Extend_Events_Admin_Page', |
|
| 65 | - // array($this, 'autosave_handling') |
|
| 66 | - // ); |
|
| 67 | - add_filter( |
|
| 68 | - 'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks', |
|
| 69 | - array($this, 'caf_updates') |
|
| 70 | - ); |
|
| 71 | - } |
|
| 72 | - |
|
| 73 | - |
|
| 74 | - |
|
| 75 | - /** |
|
| 76 | - * @return void |
|
| 77 | - */ |
|
| 78 | - protected function _setup_metaboxes() |
|
| 79 | - { |
|
| 80 | - //if we were going to add our own metaboxes we'd use the below. |
|
| 81 | - $this->_metaboxes = array( |
|
| 82 | - 0 => array( |
|
| 83 | - 'page_route' => array('edit', 'create_new'), |
|
| 84 | - 'func' => 'pricing_metabox', |
|
| 85 | - 'label' => esc_html__('Event Tickets & Datetimes', 'event_espresso'), |
|
| 86 | - 'priority' => 'high', |
|
| 87 | - 'context' => 'normal', |
|
| 88 | - ), |
|
| 89 | - ); |
|
| 90 | - $this->_remove_metaboxes = array( |
|
| 91 | - 0 => array( |
|
| 92 | - 'page_route' => array('edit', 'create_new'), |
|
| 93 | - 'id' => 'espresso_event_editor_tickets', |
|
| 94 | - 'context' => 'normal', |
|
| 95 | - ), |
|
| 96 | - ); |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * @return void |
|
| 103 | - */ |
|
| 104 | - protected function _set_date_time_formats() |
|
| 105 | - { |
|
| 106 | - /** |
|
| 107 | - * Format strings for date and time. Defaults are existing behaviour from 4.1. |
|
| 108 | - * Note, that if you return null as the value for 'date', and 'time' in the array, then |
|
| 109 | - * EE will automatically use the set wp_options, 'date_format', and 'time_format'. |
|
| 110 | - * |
|
| 111 | - * @since 4.6.7 |
|
| 112 | - * @var array Expected an array returned with 'date' and 'time' keys. |
|
| 113 | - */ |
|
| 114 | - $this->_date_format_strings = apply_filters( |
|
| 115 | - 'FHEE__espresso_events_Pricing_Hooks___set_hooks_properties__date_format_strings', |
|
| 116 | - array( |
|
| 117 | - 'date' => 'Y-m-d', |
|
| 118 | - 'time' => 'h:i a', |
|
| 119 | - ) |
|
| 120 | - ); |
|
| 121 | - //validate |
|
| 122 | - $this->_date_format_strings['date'] = isset($this->_date_format_strings['date']) |
|
| 123 | - ? $this->_date_format_strings['date'] |
|
| 124 | - : null; |
|
| 125 | - $this->_date_format_strings['time'] = isset($this->_date_format_strings['time']) |
|
| 126 | - ? $this->_date_format_strings['time'] |
|
| 127 | - : null; |
|
| 128 | - $this->_date_time_format = $this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']; |
|
| 129 | - } |
|
| 130 | - |
|
| 131 | - |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * @return void |
|
| 135 | - */ |
|
| 136 | - protected function _validate_format_strings() |
|
| 137 | - { |
|
| 138 | - //validate format strings |
|
| 139 | - $format_validation = EEH_DTT_Helper::validate_format_string( |
|
| 140 | - $this->_date_time_format |
|
| 141 | - ); |
|
| 142 | - if (is_array($format_validation)) { |
|
| 143 | - $msg = '<p>'; |
|
| 144 | - $msg .= sprintf( |
|
| 145 | - esc_html__( |
|
| 146 | - 'The format "%s" was likely added via a filter and is invalid for the following reasons:', |
|
| 147 | - 'event_espresso' |
|
| 148 | - ), |
|
| 149 | - $this->_date_time_format |
|
| 150 | - ); |
|
| 151 | - $msg .= '</p><ul>'; |
|
| 152 | - foreach ($format_validation as $error) { |
|
| 153 | - $msg .= '<li>' . $error . '</li>'; |
|
| 154 | - } |
|
| 155 | - $msg .= '</ul><p>'; |
|
| 156 | - $msg .= sprintf( |
|
| 157 | - esc_html__( |
|
| 158 | - '%sPlease note that your date and time formats have been reset to "Y-m-d" and "h:i a" respectively.%s', |
|
| 159 | - 'event_espresso' |
|
| 160 | - ), |
|
| 161 | - '<span style="color:#D54E21;">', |
|
| 162 | - '</span>' |
|
| 163 | - ); |
|
| 164 | - $msg .= '</p>'; |
|
| 165 | - EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 166 | - $this->_date_format_strings = array( |
|
| 167 | - 'date' => 'Y-m-d', |
|
| 168 | - 'time' => 'h:i a', |
|
| 169 | - ); |
|
| 170 | - } |
|
| 171 | - } |
|
| 172 | - |
|
| 173 | - |
|
| 174 | - |
|
| 175 | - /** |
|
| 176 | - * @return void |
|
| 177 | - */ |
|
| 178 | - protected function _set_scripts_styles() |
|
| 179 | - { |
|
| 180 | - $this->_scripts_styles = array( |
|
| 181 | - 'registers' => array( |
|
| 182 | - 'ee-tickets-datetimes-css' => array( |
|
| 183 | - 'url' => PRICING_ASSETS_URL . 'event-tickets-datetimes.css', |
|
| 184 | - 'type' => 'css', |
|
| 185 | - ), |
|
| 186 | - 'ee-dtt-ticket-metabox' => array( |
|
| 187 | - 'url' => PRICING_ASSETS_URL . 'ee-datetime-ticket-metabox.js', |
|
| 188 | - 'depends' => array('ee-datepicker', 'ee-dialog', 'underscore'), |
|
| 189 | - ), |
|
| 190 | - ), |
|
| 191 | - 'deregisters' => array( |
|
| 192 | - 'event-editor-css' => array('type' => 'css'), |
|
| 193 | - 'event-datetime-metabox' => array('type' => 'js'), |
|
| 194 | - ), |
|
| 195 | - 'enqueues' => array( |
|
| 196 | - 'ee-tickets-datetimes-css' => array('edit', 'create_new'), |
|
| 197 | - 'ee-dtt-ticket-metabox' => array('edit', 'create_new'), |
|
| 198 | - ), |
|
| 199 | - 'localize' => array( |
|
| 200 | - 'ee-dtt-ticket-metabox' => array( |
|
| 201 | - 'DTT_TRASH_BLOCK' => array( |
|
| 202 | - 'main_warning' => esc_html__( |
|
| 203 | - 'The Datetime you are attempting to trash is the only datetime selected for the following ticket(s):', |
|
| 204 | - 'event_espresso' |
|
| 205 | - ), |
|
| 206 | - 'after_warning' => esc_html__( |
|
| 207 | - 'In order to trash this datetime you must first make sure the above ticket(s) are assigned to other datetimes.', |
|
| 208 | - 'event_espresso' |
|
| 209 | - ), |
|
| 210 | - 'cancel_button' => '<button class="button-secondary ee-modal-cancel">' |
|
| 211 | - . esc_html__('Cancel', 'event_espresso') . '</button>', |
|
| 212 | - 'close_button' => '<button class="button-secondary ee-modal-cancel">' |
|
| 213 | - . esc_html__('Close', 'event_espresso') . '</button>', |
|
| 214 | - 'single_warning_from_tkt' => esc_html__( |
|
| 215 | - 'The Datetime you are attempting to unassign from this ticket is the only remaining datetime for this ticket. Tickets must always have at least one datetime assigned to them.', |
|
| 216 | - 'event_espresso' |
|
| 217 | - ), |
|
| 218 | - 'single_warning_from_dtt' => esc_html__( |
|
| 219 | - 'The ticket you are attempting to unassign from this datetime cannot be unassigned because the datetime is the only remaining datetime for the ticket. Tickets must always have at least one datetime assigned to them.', |
|
| 220 | - 'event_espresso' |
|
| 221 | - ), |
|
| 222 | - 'dismiss_button' => '<button class="button-secondary ee-modal-cancel">' |
|
| 223 | - . esc_html__('Dismiss', 'event_espresso') . '</button>', |
|
| 224 | - ), |
|
| 225 | - 'DTT_ERROR_MSG' => array( |
|
| 226 | - 'no_ticket_name' => esc_html__('General Admission', 'event_espresso'), |
|
| 227 | - 'dismiss_button' => '<div class="save-cancel-button-container"><button class="button-secondary ee-modal-cancel">' |
|
| 228 | - . esc_html__('Dismiss', 'event_espresso') . '</button></div>', |
|
| 229 | - ), |
|
| 230 | - 'DTT_OVERSELL_WARNING' => array( |
|
| 231 | - 'datetime_ticket' => esc_html__( |
|
| 232 | - 'You cannot add this ticket to this datetime because it has a sold amount that is greater than the amount of spots remaining for this datetime.', |
|
| 233 | - 'event_espresso' |
|
| 234 | - ), |
|
| 235 | - 'ticket_datetime' => esc_html__( |
|
| 236 | - 'You cannot add this datetime to this ticket because the ticket has a sold amount that is greater than the amount of spots remaining on the datetime.', |
|
| 237 | - 'event_espresso' |
|
| 238 | - ), |
|
| 239 | - ), |
|
| 240 | - 'DTT_CONVERTED_FORMATS' => EEH_DTT_Helper::convert_php_to_js_and_moment_date_formats( |
|
| 241 | - $this->_date_format_strings['date'], |
|
| 242 | - $this->_date_format_strings['time'] |
|
| 243 | - ), |
|
| 244 | - 'DTT_START_OF_WEEK' => array('dayValue' => (int)get_option('start_of_week')), |
|
| 245 | - ), |
|
| 246 | - ), |
|
| 247 | - ); |
|
| 248 | - } |
|
| 249 | - |
|
| 250 | - |
|
| 251 | - |
|
| 252 | - /** |
|
| 253 | - * @param array $update_callbacks |
|
| 254 | - * @return array |
|
| 255 | - */ |
|
| 256 | - public function caf_updates(array $update_callbacks) |
|
| 257 | - { |
|
| 258 | - foreach ($update_callbacks as $key => $callback) { |
|
| 259 | - if ($callback[1] === '_default_tickets_update') { |
|
| 260 | - unset($update_callbacks[$key]); |
|
| 261 | - } |
|
| 262 | - } |
|
| 263 | - $update_callbacks[] = array($this, 'datetime_and_tickets_caf_update'); |
|
| 264 | - return $update_callbacks; |
|
| 265 | - } |
|
| 266 | - |
|
| 267 | - |
|
| 268 | - /** |
|
| 269 | - * Handles saving everything related to Tickets (datetimes, tickets, prices) |
|
| 270 | - * |
|
| 271 | - * @param EE_Event $event The Event object we're attaching data to |
|
| 272 | - * @param array $data The request data from the form |
|
| 273 | - * @throws EE_Error |
|
| 274 | - * @throws InvalidArgumentException |
|
| 275 | - */ |
|
| 276 | - public function datetime_and_tickets_caf_update($event, $data) |
|
| 277 | - { |
|
| 278 | - //first we need to start with datetimes cause they are the "root" items attached to events. |
|
| 279 | - $saved_datetimes = $this->_update_datetimes($event, $data); |
|
| 280 | - //next tackle the tickets (and prices?) |
|
| 281 | - $this->_update_tickets($event, $saved_datetimes, $data); |
|
| 282 | - } |
|
| 283 | - |
|
| 284 | - |
|
| 285 | - /** |
|
| 286 | - * update event_datetimes |
|
| 287 | - * |
|
| 288 | - * @param EE_Event $event Event being updated |
|
| 289 | - * @param array $data the request data from the form |
|
| 290 | - * @return EE_Datetime[] |
|
| 291 | - * @throws InvalidArgumentException |
|
| 292 | - * @throws EE_Error |
|
| 293 | - */ |
|
| 294 | - protected function _update_datetimes($event, $data) |
|
| 295 | - { |
|
| 296 | - $timezone = isset($data['timezone_string']) ? $data['timezone_string'] : null; |
|
| 297 | - $saved_dtt_ids = array(); |
|
| 298 | - $saved_dtt_objs = array(); |
|
| 299 | - if (empty($data['edit_event_datetimes']) || !is_array($data['edit_event_datetimes'])) { |
|
| 300 | - throw new InvalidArgumentException( |
|
| 301 | - esc_html__( |
|
| 302 | - 'The "edit_event_datetimes" array is invalid therefore the event can not be updated.', |
|
| 303 | - 'event_espresso' |
|
| 304 | - ) |
|
| 305 | - ); |
|
| 306 | - } |
|
| 307 | - foreach ($data['edit_event_datetimes'] as $row => $datetime_data) { |
|
| 308 | - //trim all values to ensure any excess whitespace is removed. |
|
| 309 | - $datetime_data = array_map( |
|
| 310 | - function ($datetime_data) { |
|
| 311 | - return is_array($datetime_data) ? $datetime_data : trim($datetime_data); |
|
| 312 | - }, |
|
| 313 | - $datetime_data |
|
| 314 | - ); |
|
| 315 | - $datetime_data['DTT_EVT_end'] = isset($datetime_data['DTT_EVT_end']) |
|
| 316 | - && ! empty($datetime_data['DTT_EVT_end']) |
|
| 317 | - ? $datetime_data['DTT_EVT_end'] |
|
| 318 | - : $datetime_data['DTT_EVT_start']; |
|
| 319 | - $datetime_values = array( |
|
| 320 | - 'DTT_ID' => ! empty($datetime_data['DTT_ID']) |
|
| 321 | - ? $datetime_data['DTT_ID'] |
|
| 322 | - : null, |
|
| 323 | - 'DTT_name' => ! empty($datetime_data['DTT_name']) |
|
| 324 | - ? $datetime_data['DTT_name'] |
|
| 325 | - : '', |
|
| 326 | - 'DTT_description' => ! empty($datetime_data['DTT_description']) |
|
| 327 | - ? $datetime_data['DTT_description'] |
|
| 328 | - : '', |
|
| 329 | - 'DTT_EVT_start' => $datetime_data['DTT_EVT_start'], |
|
| 330 | - 'DTT_EVT_end' => $datetime_data['DTT_EVT_end'], |
|
| 331 | - 'DTT_reg_limit' => empty($datetime_data['DTT_reg_limit']) |
|
| 332 | - ? EE_INF |
|
| 333 | - : $datetime_data['DTT_reg_limit'], |
|
| 334 | - 'DTT_order' => ! isset($datetime_data['DTT_order']) |
|
| 335 | - ? $row |
|
| 336 | - : $datetime_data['DTT_order'], |
|
| 337 | - ); |
|
| 338 | - // if we have an id then let's get existing object first and then set the new values. |
|
| 339 | - // Otherwise we instantiate a new object for save. |
|
| 340 | - if (! empty($datetime_data['DTT_ID'])) { |
|
| 341 | - $datetime = EE_Registry::instance() |
|
| 342 | - ->load_model('Datetime', array($timezone)) |
|
| 343 | - ->get_one_by_ID($datetime_data['DTT_ID']); |
|
| 344 | - //set date and time format according to what is set in this class. |
|
| 345 | - $datetime->set_date_format($this->_date_format_strings['date']); |
|
| 346 | - $datetime->set_time_format($this->_date_format_strings['time']); |
|
| 347 | - foreach ($datetime_values as $field => $value) { |
|
| 348 | - $datetime->set($field, $value); |
|
| 349 | - } |
|
| 350 | - // make sure the $dtt_id here is saved just in case |
|
| 351 | - // after the add_relation_to() the autosave replaces it. |
|
| 352 | - // We need to do this so we dont' TRASH the parent DTT. |
|
| 353 | - // (save the ID for both key and value to avoid duplications) |
|
| 354 | - $saved_dtt_ids[$datetime->ID()] = $datetime->ID(); |
|
| 355 | - } else { |
|
| 356 | - $datetime = EE_Registry::instance()->load_class( |
|
| 357 | - 'Datetime', |
|
| 358 | - array( |
|
| 359 | - $datetime_values, |
|
| 360 | - $timezone, |
|
| 361 | - array($this->_date_format_strings['date'], $this->_date_format_strings['time']), |
|
| 362 | - ), |
|
| 363 | - false, |
|
| 364 | - false |
|
| 365 | - ); |
|
| 366 | - foreach ($datetime_values as $field => $value) { |
|
| 367 | - $datetime->set($field, $value); |
|
| 368 | - } |
|
| 369 | - } |
|
| 370 | - $datetime->save(); |
|
| 371 | - $datetime = $event->_add_relation_to($datetime, 'Datetime'); |
|
| 372 | - // before going any further make sure our dates are setup correctly |
|
| 373 | - // so that the end date is always equal or greater than the start date. |
|
| 374 | - if ($datetime->get_raw('DTT_EVT_start') > $datetime->get_raw('DTT_EVT_end')) { |
|
| 375 | - $datetime->set('DTT_EVT_end', $datetime->get('DTT_EVT_start')); |
|
| 376 | - $datetime = EEH_DTT_Helper::date_time_add($datetime, 'DTT_EVT_end', 'days'); |
|
| 377 | - $datetime->save(); |
|
| 378 | - } |
|
| 379 | - // now we have to make sure we add the new DTT_ID to the $saved_dtt_ids array |
|
| 380 | - // because it is possible there was a new one created for the autosave. |
|
| 381 | - // (save the ID for both key and value to avoid duplications) |
|
| 382 | - $DTT_ID = $datetime->ID(); |
|
| 383 | - $saved_dtt_ids[$DTT_ID] = $DTT_ID; |
|
| 384 | - $saved_dtt_objs[$row] = $datetime; |
|
| 385 | - //todo if ANY of these updates fail then we want the appropriate global error message. |
|
| 386 | - } |
|
| 387 | - $event->save(); |
|
| 388 | - // now we need to REMOVE any datetimes that got deleted. |
|
| 389 | - // Keep in mind that this process will only kick in for datetimes that don't have any DTT_sold on them. |
|
| 390 | - // So its safe to permanently delete at this point. |
|
| 391 | - $old_datetimes = explode(',', $data['datetime_IDs']); |
|
| 392 | - $old_datetimes = $old_datetimes[0] === '' ? array() : $old_datetimes; |
|
| 393 | - if (is_array($old_datetimes)) { |
|
| 394 | - $datetimes_to_delete = array_diff($old_datetimes, $saved_dtt_ids); |
|
| 395 | - foreach ($datetimes_to_delete as $id) { |
|
| 396 | - $id = absint($id); |
|
| 397 | - if (empty($id)) { |
|
| 398 | - continue; |
|
| 399 | - } |
|
| 400 | - $dtt_to_remove = EE_Registry::instance()->load_model('Datetime')->get_one_by_ID($id); |
|
| 401 | - //remove tkt relationships. |
|
| 402 | - $related_tickets = $dtt_to_remove->get_many_related('Ticket'); |
|
| 403 | - foreach ($related_tickets as $tkt) { |
|
| 404 | - $dtt_to_remove->_remove_relation_to($tkt, 'Ticket'); |
|
| 405 | - } |
|
| 406 | - $event->_remove_relation_to($id, 'Datetime'); |
|
| 407 | - $dtt_to_remove->refresh_cache_of_related_objects(); |
|
| 408 | - } |
|
| 409 | - } |
|
| 410 | - return $saved_dtt_objs; |
|
| 411 | - } |
|
| 412 | - |
|
| 413 | - |
|
| 414 | - /** |
|
| 415 | - * update tickets |
|
| 416 | - * |
|
| 417 | - * @param EE_Event $event Event object being updated |
|
| 418 | - * @param EE_Datetime[] $saved_datetimes an array of datetime ids being updated |
|
| 419 | - * @param array $data incoming request data |
|
| 420 | - * @return EE_Ticket[] |
|
| 421 | - * @throws InvalidArgumentException |
|
| 422 | - * @throws EE_Error |
|
| 423 | - */ |
|
| 424 | - protected function _update_tickets($event, $saved_datetimes, $data) |
|
| 425 | - { |
|
| 426 | - $new_tkt = null; |
|
| 427 | - $new_default = null; |
|
| 428 | - //stripslashes because WP filtered the $_POST ($data) array to add slashes |
|
| 429 | - $data = stripslashes_deep($data); |
|
| 430 | - $timezone = isset($data['timezone_string']) ? $data['timezone_string'] : null; |
|
| 431 | - $saved_tickets = $datetimes_on_existing = array(); |
|
| 432 | - $old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array(); |
|
| 433 | - if(empty($data['edit_tickets']) || ! is_array($data['edit_tickets'])){ |
|
| 434 | - throw new InvalidArgumentException( |
|
| 435 | - esc_html__( |
|
| 436 | - 'The "edit_tickets" array is invalid therefore the event can not be updated.', |
|
| 437 | - 'event_espresso' |
|
| 438 | - ) |
|
| 439 | - ); |
|
| 440 | - } |
|
| 441 | - foreach ($data['edit_tickets'] as $row => $tkt) { |
|
| 442 | - $update_prices = $create_new_TKT = false; |
|
| 443 | - // figure out what datetimes were added to the ticket |
|
| 444 | - // and what datetimes were removed from the ticket in the session. |
|
| 445 | - $starting_tkt_dtt_rows = explode(',', $data['starting_ticket_datetime_rows'][$row]); |
|
| 446 | - $tkt_dtt_rows = explode(',', $data['ticket_datetime_rows'][$row]); |
|
| 447 | - $datetimes_added = array_diff($tkt_dtt_rows, $starting_tkt_dtt_rows); |
|
| 448 | - $datetimes_removed = array_diff($starting_tkt_dtt_rows, $tkt_dtt_rows); |
|
| 449 | - // trim inputs to ensure any excess whitespace is removed. |
|
| 450 | - $tkt = array_map( |
|
| 451 | - function ($ticket_data) { |
|
| 452 | - return is_array($ticket_data) ? $ticket_data : trim($ticket_data); |
|
| 453 | - }, |
|
| 454 | - $tkt |
|
| 455 | - ); |
|
| 456 | - // note we are doing conversions to floats here instead of allowing EE_Money_Field to handle |
|
| 457 | - // because we're doing calculations prior to using the models. |
|
| 458 | - // note incoming ['TKT_price'] value is already in standard notation (via js). |
|
| 459 | - $ticket_price = isset($tkt['TKT_price']) |
|
| 460 | - ? round((float)$tkt['TKT_price'], 3) |
|
| 461 | - : 0; |
|
| 462 | - //note incoming base price needs converted from localized value. |
|
| 463 | - $base_price = isset($tkt['TKT_base_price']) |
|
| 464 | - ? EEH_Money::convert_to_float_from_localized_money($tkt['TKT_base_price']) |
|
| 465 | - : 0; |
|
| 466 | - //if ticket price == 0 and $base_price != 0 then ticket price == base_price |
|
| 467 | - $ticket_price = $ticket_price === 0 && $base_price !== 0 |
|
| 468 | - ? $base_price |
|
| 469 | - : $ticket_price; |
|
| 470 | - $base_price_id = isset($tkt['TKT_base_price_ID']) |
|
| 471 | - ? $tkt['TKT_base_price_ID'] |
|
| 472 | - : 0; |
|
| 473 | - $price_rows = is_array($data['edit_prices']) && isset($data['edit_prices'][$row]) |
|
| 474 | - ? $data['edit_prices'][$row] |
|
| 475 | - : array(); |
|
| 476 | - $now = null; |
|
| 477 | - if (empty($tkt['TKT_start_date'])) { |
|
| 478 | - //lets' use now in the set timezone. |
|
| 479 | - $now = new DateTime('now', new DateTimeZone($event->get_timezone())); |
|
| 480 | - $tkt['TKT_start_date'] = $now->format($this->_date_time_format); |
|
| 481 | - } |
|
| 482 | - if (empty($tkt['TKT_end_date'])) { |
|
| 483 | - /** |
|
| 484 | - * set the TKT_end_date to the first datetime attached to the ticket. |
|
| 485 | - */ |
|
| 486 | - $first_dtt = $saved_datetimes[reset($tkt_dtt_rows)]; |
|
| 487 | - $tkt['TKT_end_date'] = $first_dtt->start_date_and_time($this->_date_time_format); |
|
| 488 | - } |
|
| 489 | - $TKT_values = array( |
|
| 490 | - 'TKT_ID' => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null, |
|
| 491 | - 'TTM_ID' => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0, |
|
| 492 | - 'TKT_name' => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '', |
|
| 493 | - 'TKT_description' => ! empty($tkt['TKT_description']) |
|
| 494 | - && $tkt['TKT_description'] !== esc_html__( |
|
| 495 | - 'You can modify this description', |
|
| 496 | - 'event_espresso' |
|
| 497 | - ) |
|
| 498 | - ? $tkt['TKT_description'] |
|
| 499 | - : '', |
|
| 500 | - 'TKT_start_date' => $tkt['TKT_start_date'], |
|
| 501 | - 'TKT_end_date' => $tkt['TKT_end_date'], |
|
| 502 | - 'TKT_qty' => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' |
|
| 503 | - ? EE_INF |
|
| 504 | - : $tkt['TKT_qty'], |
|
| 505 | - 'TKT_uses' => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' |
|
| 506 | - ? EE_INF |
|
| 507 | - : $tkt['TKT_uses'], |
|
| 508 | - 'TKT_min' => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'], |
|
| 509 | - 'TKT_max' => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'], |
|
| 510 | - 'TKT_row' => $row, |
|
| 511 | - 'TKT_order' => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : 0, |
|
| 512 | - 'TKT_taxable' => ! empty($tkt['TKT_taxable']) ? 1 : 0, |
|
| 513 | - 'TKT_required' => ! empty($tkt['TKT_required']) ? 1 : 0, |
|
| 514 | - 'TKT_price' => $ticket_price, |
|
| 515 | - ); |
|
| 516 | - // if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, |
|
| 517 | - // which means in turn that the prices will become new prices as well. |
|
| 518 | - if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) { |
|
| 519 | - $TKT_values['TKT_ID'] = 0; |
|
| 520 | - $TKT_values['TKT_is_default'] = 0; |
|
| 521 | - $update_prices = true; |
|
| 522 | - } |
|
| 523 | - // if we have a TKT_ID then we need to get that existing TKT_obj and update it |
|
| 524 | - // we actually do our saves ahead of doing any add_relations to |
|
| 525 | - // because its entirely possible that this ticket wasn't removed or added to any datetime in the session |
|
| 526 | - // but DID have it's items modified. |
|
| 527 | - // keep in mind that if the TKT has been sold (and we have changed pricing information), |
|
| 528 | - // then we won't be updating the tkt but instead a new tkt will be created and the old one archived. |
|
| 529 | - if (absint($TKT_values['TKT_ID'])) { |
|
| 530 | - $ticket = EE_Registry::instance() |
|
| 531 | - ->load_model('Ticket', array($timezone)) |
|
| 532 | - ->get_one_by_ID($tkt['TKT_ID']); |
|
| 533 | - if ($ticket instanceof EE_Ticket) { |
|
| 534 | - $ticket = $this->_update_ticket_datetimes( |
|
| 535 | - $ticket, |
|
| 536 | - $saved_datetimes, |
|
| 537 | - $datetimes_added, |
|
| 538 | - $datetimes_removed |
|
| 539 | - ); |
|
| 540 | - // are there any registrations using this ticket ? |
|
| 541 | - $tickets_sold = $ticket->count_related( |
|
| 542 | - 'Registration', |
|
| 543 | - array( |
|
| 544 | - array( |
|
| 545 | - 'STS_ID' => array('NOT IN', array(EEM_Registration::status_id_incomplete)), |
|
| 546 | - ), |
|
| 547 | - ) |
|
| 548 | - ); |
|
| 549 | - //set ticket formats |
|
| 550 | - $ticket->set_date_format($this->_date_format_strings['date']); |
|
| 551 | - $ticket->set_time_format($this->_date_format_strings['time']); |
|
| 552 | - // let's just check the total price for the existing ticket |
|
| 553 | - // and determine if it matches the new total price. |
|
| 554 | - // if they are different then we create a new ticket (if tickets sold) |
|
| 555 | - // if they aren't different then we go ahead and modify existing ticket. |
|
| 556 | - $create_new_TKT = $tickets_sold > 0 && $ticket_price !== $ticket->price() && ! $ticket->deleted(); |
|
| 557 | - //set new values |
|
| 558 | - foreach ($TKT_values as $field => $value) { |
|
| 559 | - if ($field === 'TKT_qty') { |
|
| 560 | - $ticket->set_qty($value); |
|
| 561 | - } else { |
|
| 562 | - $ticket->set($field, $value); |
|
| 563 | - } |
|
| 564 | - } |
|
| 565 | - // if $create_new_TKT is false then we can safely update the existing ticket. |
|
| 566 | - // Otherwise we have to create a new ticket. |
|
| 567 | - if ($create_new_TKT) { |
|
| 568 | - $new_tkt = $this->_duplicate_ticket($ticket, $price_rows, $ticket_price, $base_price, |
|
| 569 | - $base_price_id); |
|
| 570 | - } |
|
| 571 | - } |
|
| 572 | - } else { |
|
| 573 | - // no TKT_id so a new TKT |
|
| 574 | - $ticket = EE_Ticket::new_instance( |
|
| 575 | - $TKT_values, |
|
| 576 | - $timezone, |
|
| 577 | - array($this->_date_format_strings['date'], $this->_date_format_strings['time']) |
|
| 578 | - ); |
|
| 579 | - if ($ticket instanceof EE_Ticket) { |
|
| 580 | - // make sure ticket has an ID of setting relations won't work |
|
| 581 | - $ticket->save(); |
|
| 582 | - $ticket = $this->_update_ticket_datetimes( |
|
| 583 | - $ticket, |
|
| 584 | - $saved_datetimes, |
|
| 585 | - $datetimes_added, |
|
| 586 | - $datetimes_removed |
|
| 587 | - ); |
|
| 588 | - $update_prices = true; |
|
| 589 | - } |
|
| 590 | - } |
|
| 591 | - //make sure any current values have been saved. |
|
| 592 | - //$ticket->save(); |
|
| 593 | - // before going any further make sure our dates are setup correctly |
|
| 594 | - // so that the end date is always equal or greater than the start date. |
|
| 595 | - if ($ticket->get_raw('TKT_start_date') > $ticket->get_raw('TKT_end_date')) { |
|
| 596 | - $ticket->set('TKT_end_date', $ticket->get('TKT_start_date')); |
|
| 597 | - $ticket = EEH_DTT_Helper::date_time_add($ticket, 'TKT_end_date', 'days'); |
|
| 598 | - } |
|
| 599 | - //let's make sure the base price is handled |
|
| 600 | - $ticket = ! $create_new_TKT ? $this->_add_prices_to_ticket(array(), $ticket, $update_prices, $base_price, |
|
| 601 | - $base_price_id) : $ticket; |
|
| 602 | - //add/update price_modifiers |
|
| 603 | - $ticket = ! $create_new_TKT ? $this->_add_prices_to_ticket($price_rows, $ticket, $update_prices) : $ticket; |
|
| 604 | - //need to make sue that the TKT_price is accurate after saving the prices. |
|
| 605 | - $ticket->ensure_TKT_Price_correct(); |
|
| 606 | - //handle CREATING a default tkt from the incoming tkt but ONLY if this isn't an autosave. |
|
| 607 | - if (! defined('DOING_AUTOSAVE') && ! empty($tkt['TKT_is_default_selector'])) { |
|
| 608 | - $update_prices = true; |
|
| 609 | - $new_default = clone $ticket; |
|
| 610 | - $new_default->set('TKT_ID', 0); |
|
| 611 | - $new_default->set('TKT_is_default', 1); |
|
| 612 | - $new_default->set('TKT_row', 1); |
|
| 613 | - $new_default->set('TKT_price', $ticket_price); |
|
| 614 | - // remove any dtt relations cause we DON'T want dtt relations attached |
|
| 615 | - // (note this is just removing the cached relations in the object) |
|
| 616 | - $new_default->_remove_relations('Datetime'); |
|
| 617 | - //todo we need to add the current attached prices as new prices to the new default ticket. |
|
| 618 | - $new_default = $this->_add_prices_to_ticket($price_rows, $new_default, $update_prices); |
|
| 619 | - //don't forget the base price! |
|
| 620 | - $new_default = $this->_add_prices_to_ticket( |
|
| 621 | - array(), |
|
| 622 | - $new_default, |
|
| 623 | - $update_prices, |
|
| 624 | - $base_price, |
|
| 625 | - $base_price_id |
|
| 626 | - ); |
|
| 627 | - $new_default->save(); |
|
| 628 | - do_action( |
|
| 629 | - 'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_default_ticket', |
|
| 630 | - $new_default, |
|
| 631 | - $row, |
|
| 632 | - $ticket, |
|
| 633 | - $data |
|
| 634 | - ); |
|
| 635 | - } |
|
| 636 | - // DO ALL dtt relationships for both current tickets and any archived tickets |
|
| 637 | - // for the given dtt that are related to the current ticket. |
|
| 638 | - // TODO... not sure exactly how we're going to do this considering we don't know |
|
| 639 | - // what current ticket the archived tickets are related to |
|
| 640 | - // (and TKT_parent is used for autosaves so that's not a field we can reliably use). |
|
| 641 | - //let's assign any tickets that have been setup to the saved_tickets tracker |
|
| 642 | - //save existing TKT |
|
| 643 | - $ticket->save(); |
|
| 644 | - if ($create_new_TKT && $new_tkt instanceof EE_Ticket) { |
|
| 645 | - //save new TKT |
|
| 646 | - $new_tkt->save(); |
|
| 647 | - //add new ticket to array |
|
| 648 | - $saved_tickets[$new_tkt->ID()] = $new_tkt; |
|
| 649 | - do_action( |
|
| 650 | - 'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_ticket', |
|
| 651 | - $new_tkt, |
|
| 652 | - $row, |
|
| 653 | - $tkt, |
|
| 654 | - $data |
|
| 655 | - ); |
|
| 656 | - } else { |
|
| 657 | - //add tkt to saved tkts |
|
| 658 | - $saved_tickets[$ticket->ID()] = $ticket; |
|
| 659 | - do_action( |
|
| 660 | - 'AHEE__espresso_events_Pricing_Hooks___update_tkts_update_ticket', |
|
| 661 | - $ticket, |
|
| 662 | - $row, |
|
| 663 | - $tkt, |
|
| 664 | - $data |
|
| 665 | - ); |
|
| 666 | - } |
|
| 667 | - } |
|
| 668 | - // now we need to handle tickets actually "deleted permanently". |
|
| 669 | - // There are cases where we'd want this to happen |
|
| 670 | - // (i.e. autosaves are happening and then in between autosaves the user trashes a ticket). |
|
| 671 | - // Or a draft event was saved and in the process of editing a ticket is trashed. |
|
| 672 | - // No sense in keeping all the related data in the db! |
|
| 673 | - $old_tickets = isset($old_tickets[0]) && $old_tickets[0] === '' ? array() : $old_tickets; |
|
| 674 | - $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets)); |
|
| 675 | - foreach ($tickets_removed as $id) { |
|
| 676 | - $id = absint($id); |
|
| 677 | - //get the ticket for this id |
|
| 678 | - $tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id); |
|
| 679 | - //if this tkt is a default tkt we leave it alone cause it won't be attached to the datetime |
|
| 680 | - if ($tkt_to_remove->get('TKT_is_default')) { |
|
| 681 | - continue; |
|
| 682 | - } |
|
| 683 | - // if this tkt has any registrations attached so then we just ARCHIVE |
|
| 684 | - // because we don't actually permanently delete these tickets. |
|
| 685 | - if ($tkt_to_remove->count_related('Registration') > 0) { |
|
| 686 | - $tkt_to_remove->delete(); |
|
| 687 | - continue; |
|
| 688 | - } |
|
| 689 | - // need to get all the related datetimes on this ticket and remove from every single one of them |
|
| 690 | - // (remember this process can ONLY kick off if there are NO tkts_sold) |
|
| 691 | - $datetimes = $tkt_to_remove->get_many_related('Datetime'); |
|
| 692 | - foreach ($datetimes as $datetime) { |
|
| 693 | - $tkt_to_remove->_remove_relation_to($datetime, 'Datetime'); |
|
| 694 | - } |
|
| 695 | - // need to do the same for prices (except these prices can also be deleted because again, |
|
| 696 | - // tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived)) |
|
| 697 | - $tkt_to_remove->delete_related_permanently('Price'); |
|
| 698 | - do_action('AHEE__espresso_events_Pricing_Hooks___update_tkts_delete_ticket', $tkt_to_remove); |
|
| 699 | - // finally let's delete this ticket |
|
| 700 | - // (which should not be blocked at this point b/c we've removed all our relationships) |
|
| 701 | - $tkt_to_remove->delete_permanently(); |
|
| 702 | - } |
|
| 703 | - return $saved_tickets; |
|
| 704 | - } |
|
| 705 | - |
|
| 706 | - |
|
| 707 | - |
|
| 708 | - /** |
|
| 709 | - * @access protected |
|
| 710 | - * @param \EE_Ticket $ticket |
|
| 711 | - * @param \EE_Datetime[] $saved_datetimes |
|
| 712 | - * @param \EE_Datetime[] $added_datetimes |
|
| 713 | - * @param \EE_Datetime[] $removed_datetimes |
|
| 714 | - * @return \EE_Ticket |
|
| 715 | - * @throws \EE_Error |
|
| 716 | - */ |
|
| 717 | - protected function _update_ticket_datetimes( |
|
| 718 | - EE_Ticket $ticket, |
|
| 719 | - $saved_datetimes = array(), |
|
| 720 | - $added_datetimes = array(), |
|
| 721 | - $removed_datetimes = array() |
|
| 722 | - ) { |
|
| 723 | - // to start we have to add the ticket to all the datetimes its supposed to be with, |
|
| 724 | - // and removing the ticket from datetimes it got removed from. |
|
| 725 | - // first let's add datetimes |
|
| 726 | - if (! empty($added_datetimes) && is_array($added_datetimes)) { |
|
| 727 | - foreach ($added_datetimes as $row_id) { |
|
| 728 | - $row_id = (int)$row_id; |
|
| 729 | - if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) { |
|
| 730 | - $ticket->_add_relation_to($saved_datetimes[$row_id], 'Datetime'); |
|
| 731 | - // Is this an existing ticket (has an ID) and does it have any sold? |
|
| 732 | - // If so, then we need to add that to the DTT sold because this DTT is getting added. |
|
| 733 | - if ($ticket->ID() && $ticket->sold() > 0) { |
|
| 734 | - $saved_datetimes[$row_id]->increase_sold($ticket->sold()); |
|
| 735 | - $saved_datetimes[$row_id]->save(); |
|
| 736 | - } |
|
| 737 | - } |
|
| 738 | - } |
|
| 739 | - } |
|
| 740 | - // then remove datetimes |
|
| 741 | - if (! empty($removed_datetimes) && is_array($removed_datetimes)) { |
|
| 742 | - foreach ($removed_datetimes as $row_id) { |
|
| 743 | - $row_id = (int)$row_id; |
|
| 744 | - // its entirely possible that a datetime got deleted (instead of just removed from relationship. |
|
| 745 | - // So make sure we skip over this if the dtt isn't in the $saved_datetimes array) |
|
| 746 | - if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) { |
|
| 747 | - $ticket->_remove_relation_to($saved_datetimes[$row_id], 'Datetime'); |
|
| 748 | - // Is this an existing ticket (has an ID) and does it have any sold? |
|
| 749 | - // If so, then we need to remove it's sold from the DTT_sold. |
|
| 750 | - if ($ticket->ID() && $ticket->sold() > 0) { |
|
| 751 | - $saved_datetimes[$row_id]->decrease_sold($ticket->sold()); |
|
| 752 | - $saved_datetimes[$row_id]->save(); |
|
| 753 | - } |
|
| 754 | - } |
|
| 755 | - } |
|
| 756 | - } |
|
| 757 | - // cap ticket qty by datetime reg limits |
|
| 758 | - $ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit'))); |
|
| 759 | - return $ticket; |
|
| 760 | - } |
|
| 761 | - |
|
| 762 | - |
|
| 763 | - |
|
| 764 | - /** |
|
| 765 | - * @access protected |
|
| 766 | - * @param \EE_Ticket $ticket |
|
| 767 | - * @param array $price_rows |
|
| 768 | - * @param int $ticket_price |
|
| 769 | - * @param int $base_price |
|
| 770 | - * @param int $base_price_id |
|
| 771 | - * @return \EE_Ticket |
|
| 772 | - * @throws \EE_Error |
|
| 773 | - */ |
|
| 774 | - protected function _duplicate_ticket( |
|
| 775 | - EE_Ticket $ticket, |
|
| 776 | - $price_rows = array(), |
|
| 777 | - $ticket_price = 0, |
|
| 778 | - $base_price = 0, |
|
| 779 | - $base_price_id = 0 |
|
| 780 | - ) { |
|
| 781 | - // create new ticket that's a copy of the existing |
|
| 782 | - // except a new id of course (and not archived) |
|
| 783 | - // AND has the new TKT_price associated with it. |
|
| 784 | - $new_ticket = clone $ticket; |
|
| 785 | - $new_ticket->set('TKT_ID', 0); |
|
| 786 | - $new_ticket->set_deleted(0); |
|
| 787 | - $new_ticket->set_price($ticket_price); |
|
| 788 | - $new_ticket->set_sold(0); |
|
| 789 | - // let's get a new ID for this ticket |
|
| 790 | - $new_ticket->save(); |
|
| 791 | - // we also need to make sure this new ticket gets the same datetime attachments as the archived ticket |
|
| 792 | - $datetimes_on_existing = $ticket->datetimes(); |
|
| 793 | - $new_ticket = $this->_update_ticket_datetimes( |
|
| 794 | - $new_ticket, |
|
| 795 | - $datetimes_on_existing, |
|
| 796 | - array_keys($datetimes_on_existing) |
|
| 797 | - ); |
|
| 798 | - // $ticket will get archived later b/c we are NOT adding it to the saved_tickets array. |
|
| 799 | - // if existing $ticket has sold amount, then we need to adjust the qty for the new TKT to = the remaining |
|
| 800 | - // available. |
|
| 801 | - if ($ticket->sold() > 0) { |
|
| 802 | - $new_qty = $ticket->qty() - $ticket->sold(); |
|
| 803 | - $new_ticket->set_qty($new_qty); |
|
| 804 | - } |
|
| 805 | - //now we update the prices just for this ticket |
|
| 806 | - $new_ticket = $this->_add_prices_to_ticket($price_rows, $new_ticket, true); |
|
| 807 | - //and we update the base price |
|
| 808 | - $new_ticket = $this->_add_prices_to_ticket(array(), $new_ticket, true, $base_price, $base_price_id); |
|
| 809 | - return $new_ticket; |
|
| 810 | - } |
|
| 811 | - |
|
| 812 | - |
|
| 813 | - |
|
| 814 | - /** |
|
| 815 | - * This attaches a list of given prices to a ticket. |
|
| 816 | - * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change |
|
| 817 | - * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old |
|
| 818 | - * price info and prices are automatically "archived" via the ticket. |
|
| 819 | - * |
|
| 820 | - * @access private |
|
| 821 | - * @param array $prices Array of prices from the form. |
|
| 822 | - * @param EE_Ticket $ticket EE_Ticket object that prices are being attached to. |
|
| 823 | - * @param bool $new_prices Whether attach existing incoming prices or create new ones. |
|
| 824 | - * @param int|bool $base_price if FALSE then NOT doing a base price add. |
|
| 825 | - * @param int|bool $base_price_id if present then this is the base_price_id being updated. |
|
| 826 | - * @return EE_Ticket |
|
| 827 | - * @throws EE_Error |
|
| 828 | - */ |
|
| 829 | - protected function _add_prices_to_ticket( |
|
| 830 | - $prices = array(), |
|
| 831 | - EE_Ticket $ticket, |
|
| 832 | - $new_prices = false, |
|
| 833 | - $base_price = false, |
|
| 834 | - $base_price_id = false |
|
| 835 | - ) { |
|
| 836 | - // let's just get any current prices that may exist on the given ticket |
|
| 837 | - // so we can remove any prices that got trashed in this session. |
|
| 838 | - $current_prices_on_ticket = $base_price !== false |
|
| 839 | - ? $ticket->base_price(true) |
|
| 840 | - : $ticket->price_modifiers(); |
|
| 841 | - $updated_prices = array(); |
|
| 842 | - // if $base_price ! FALSE then updating a base price. |
|
| 843 | - if ($base_price !== false) { |
|
| 844 | - $prices[1] = array( |
|
| 845 | - 'PRC_ID' => $new_prices || $base_price_id === 1 ? null : $base_price_id, |
|
| 846 | - 'PRT_ID' => 1, |
|
| 847 | - 'PRC_amount' => $base_price, |
|
| 848 | - 'PRC_name' => $ticket->get('TKT_name'), |
|
| 849 | - 'PRC_desc' => $ticket->get('TKT_description'), |
|
| 850 | - ); |
|
| 851 | - } |
|
| 852 | - //possibly need to save tkt |
|
| 853 | - if (! $ticket->ID()) { |
|
| 854 | - $ticket->save(); |
|
| 855 | - } |
|
| 856 | - foreach ($prices as $row => $prc) { |
|
| 857 | - $prt_id = ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null; |
|
| 858 | - if (empty($prt_id)) { |
|
| 859 | - continue; |
|
| 860 | - } //prices MUST have a price type id. |
|
| 861 | - $PRC_values = array( |
|
| 862 | - 'PRC_ID' => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null, |
|
| 863 | - 'PRT_ID' => $prt_id, |
|
| 864 | - 'PRC_amount' => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0, |
|
| 865 | - 'PRC_name' => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '', |
|
| 866 | - 'PRC_desc' => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '', |
|
| 867 | - 'PRC_is_default' => false, |
|
| 868 | - //make sure we set PRC_is_default to false for all ticket saves from event_editor |
|
| 869 | - 'PRC_order' => $row, |
|
| 870 | - ); |
|
| 871 | - if ($new_prices || empty($PRC_values['PRC_ID'])) { |
|
| 872 | - $PRC_values['PRC_ID'] = 0; |
|
| 873 | - $price = EE_Registry::instance()->load_class( |
|
| 874 | - 'Price', |
|
| 875 | - array($PRC_values), |
|
| 876 | - false, |
|
| 877 | - false |
|
| 878 | - ); |
|
| 879 | - } else { |
|
| 880 | - $price = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']); |
|
| 881 | - //update this price with new values |
|
| 882 | - foreach ($PRC_values as $field => $value) { |
|
| 883 | - $price->set($field, $value); |
|
| 884 | - } |
|
| 885 | - } |
|
| 886 | - $price->save(); |
|
| 887 | - $updated_prices[$price->ID()] = $price; |
|
| 888 | - $ticket->_add_relation_to($price, 'Price'); |
|
| 889 | - } |
|
| 890 | - //now let's remove any prices that got removed from the ticket |
|
| 891 | - if (! empty ($current_prices_on_ticket)) { |
|
| 892 | - $current = array_keys($current_prices_on_ticket); |
|
| 893 | - $updated = array_keys($updated_prices); |
|
| 894 | - $prices_to_remove = array_diff($current, $updated); |
|
| 895 | - if (! empty($prices_to_remove)) { |
|
| 896 | - foreach ($prices_to_remove as $prc_id) { |
|
| 897 | - $p = $current_prices_on_ticket[$prc_id]; |
|
| 898 | - $ticket->_remove_relation_to($p, 'Price'); |
|
| 899 | - //delete permanently the price |
|
| 900 | - $p->delete_permanently(); |
|
| 901 | - } |
|
| 902 | - } |
|
| 903 | - } |
|
| 904 | - return $ticket; |
|
| 905 | - } |
|
| 906 | - |
|
| 907 | - |
|
| 908 | - |
|
| 909 | - /** |
|
| 910 | - * @param Events_Admin_Page $event_admin_obj |
|
| 911 | - * @return Events_Admin_Page |
|
| 912 | - */ |
|
| 913 | - public function autosave_handling( Events_Admin_Page $event_admin_obj) |
|
| 914 | - { |
|
| 915 | - return $event_admin_obj; |
|
| 916 | - //doing nothing for the moment. |
|
| 917 | - // todo when I get to this remember that I need to set the template args on the $event_admin_obj |
|
| 918 | - // (use the set_template_args() method) |
|
| 919 | - /** |
|
| 920 | - * need to remember to handle TICKET DEFAULT saves correctly: I've got two input fields in the dom: |
|
| 921 | - * 1. TKT_is_default_selector (visible) |
|
| 922 | - * 2. TKT_is_default (hidden) |
|
| 923 | - * I think we'll use the TKT_is_default for recording whether the ticket displayed IS a default ticket |
|
| 924 | - * (on new event creations). Whereas the TKT_is_default_selector is for the user to indicate they want |
|
| 925 | - * this ticket to be saved as a default. |
|
| 926 | - * The tricky part is, on an initial display on create or edit (or after manually updating), |
|
| 927 | - * the TKT_is_default_selector will always be unselected and the TKT_is_default will only be true |
|
| 928 | - * if this is a create. However, after an autosave, users will want some sort of indicator that |
|
| 929 | - * the TKT HAS been saved as a default.. |
|
| 930 | - * in other words we don't want to remove the check on TKT_is_default_selector. So here's what I'm thinking. |
|
| 931 | - * On Autosave: |
|
| 932 | - * 1. If TKT_is_default is true: we create a new TKT, send back the new id and add id to related elements, |
|
| 933 | - * then set the TKT_is_default to false. |
|
| 934 | - * 2. If TKT_is_default_selector is true: we create/edit existing ticket (following conditions above as well). |
|
| 935 | - * We do NOT create a new default ticket. The checkbox stays selected after autosave. |
|
| 936 | - * 3. only on MANUAL update do we check for the selection and if selected create the new default ticket. |
|
| 937 | - */ |
|
| 938 | - } |
|
| 939 | - |
|
| 940 | - |
|
| 941 | - |
|
| 942 | - /** |
|
| 943 | - * @throws DomainException |
|
| 944 | - * @throws EE_Error |
|
| 945 | - */ |
|
| 946 | - public function pricing_metabox() |
|
| 947 | - { |
|
| 948 | - $existing_datetime_ids = $existing_ticket_ids = $datetime_tickets = $ticket_datetimes = array(); |
|
| 949 | - $event = $this->_adminpage_obj->get_cpt_model_obj(); |
|
| 950 | - //set is_creating_event property. |
|
| 951 | - $EVT_ID = $event->ID(); |
|
| 952 | - $this->_is_creating_event = absint($EVT_ID) === 0; |
|
| 953 | - //default main template args |
|
| 954 | - $main_template_args = array( |
|
| 955 | - 'event_datetime_help_link' => EEH_Template::get_help_tab_link( |
|
| 956 | - 'event_editor_event_datetimes_help_tab', |
|
| 957 | - $this->_adminpage_obj->page_slug, |
|
| 958 | - $this->_adminpage_obj->get_req_action(), |
|
| 959 | - false, |
|
| 960 | - false |
|
| 961 | - ), |
|
| 962 | - // todo need to add a filter to the template for the help text |
|
| 963 | - // in the Events_Admin_Page core file so we can add further help |
|
| 964 | - 'existing_datetime_ids' => '', |
|
| 965 | - 'total_dtt_rows' => 1, |
|
| 966 | - 'add_new_dtt_help_link' => EEH_Template::get_help_tab_link( |
|
| 967 | - 'add_new_dtt_info', |
|
| 968 | - $this->_adminpage_obj->page_slug, |
|
| 969 | - $this->_adminpage_obj->get_req_action(), |
|
| 970 | - false, |
|
| 971 | - false |
|
| 972 | - ), |
|
| 973 | - //todo need to add this help info id to the Events_Admin_Page core file so we can access it here. |
|
| 974 | - 'datetime_rows' => '', |
|
| 975 | - 'show_tickets_container' => '', |
|
| 976 | - //$this->_adminpage_obj->get_cpt_model_obj()->ID() > 1 ? ' style="display:none;"' : '', |
|
| 977 | - 'ticket_rows' => '', |
|
| 978 | - 'existing_ticket_ids' => '', |
|
| 979 | - 'total_ticket_rows' => 1, |
|
| 980 | - 'ticket_js_structure' => '', |
|
| 981 | - 'ee_collapsible_status' => ' ee-collapsible-open' |
|
| 982 | - //$this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? ' ee-collapsible-closed' : ' ee-collapsible-open' |
|
| 983 | - ); |
|
| 984 | - $timezone = $event instanceof EE_Event ? $event->timezone_string() : null; |
|
| 985 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 986 | - /** |
|
| 987 | - * 1. Start with retrieving Datetimes |
|
| 988 | - * 2. For each datetime get related tickets |
|
| 989 | - * 3. For each ticket get related prices |
|
| 990 | - */ |
|
| 991 | - /** @var EEM_Datetime $datetime_model */ |
|
| 992 | - $datetime_model = EE_Registry::instance()->load_model('Datetime', array($timezone)); |
|
| 993 | - $datetimes = $datetime_model->get_all_event_dates($EVT_ID); |
|
| 994 | - $main_template_args['total_dtt_rows'] = count($datetimes); |
|
| 995 | - /** |
|
| 996 | - * @see https://events.codebasehq.com/projects/event-espresso/tickets/9486 |
|
| 997 | - * for why we are counting $datetime_row and then setting that on the Datetime object |
|
| 998 | - */ |
|
| 999 | - $datetime_row = 1; |
|
| 1000 | - foreach ($datetimes as $datetime) { |
|
| 1001 | - $DTT_ID = $datetime->get('DTT_ID'); |
|
| 1002 | - $datetime->set('DTT_order', $datetime_row); |
|
| 1003 | - $existing_datetime_ids[] = $DTT_ID; |
|
| 1004 | - //tickets attached |
|
| 1005 | - $related_tickets = $datetime->ID() > 0 |
|
| 1006 | - ? $datetime->get_many_related( |
|
| 1007 | - 'Ticket', |
|
| 1008 | - array( |
|
| 1009 | - array( |
|
| 1010 | - 'OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0), |
|
| 1011 | - ), |
|
| 1012 | - 'default_where_conditions' => 'none', |
|
| 1013 | - 'order_by' => array('TKT_order' => 'ASC'), |
|
| 1014 | - ) |
|
| 1015 | - ) |
|
| 1016 | - : array(); |
|
| 1017 | - //if there are no related tickets this is likely a new event OR autodraft |
|
| 1018 | - // event so we need to generate the default tickets because datetimes |
|
| 1019 | - // ALWAYS have at least one related ticket!!. EXCEPT, we dont' do this if there is already more than one |
|
| 1020 | - // datetime on the event. |
|
| 1021 | - if (empty ($related_tickets) && count($datetimes) < 2) { |
|
| 1022 | - /** @var EEM_Ticket $ticket_model */ |
|
| 1023 | - $ticket_model = EE_Registry::instance()->load_model('Ticket'); |
|
| 1024 | - $related_tickets = $ticket_model->get_all_default_tickets(); |
|
| 1025 | - // this should be ordered by TKT_ID, so let's grab the first default ticket |
|
| 1026 | - // (which will be the main default) and ensure it has any default prices added to it (but do NOT save). |
|
| 1027 | - $default_prices = EEM_Price::instance()->get_all_default_prices(); |
|
| 1028 | - $main_default_ticket = reset($related_tickets); |
|
| 1029 | - if ($main_default_ticket instanceof EE_Ticket) { |
|
| 1030 | - foreach ($default_prices as $default_price) { |
|
| 1031 | - if ($default_price instanceof EE_Price && $default_price->is_base_price()) { |
|
| 1032 | - continue; |
|
| 1033 | - } |
|
| 1034 | - $main_default_ticket->cache('Price', $default_price); |
|
| 1035 | - } |
|
| 1036 | - } |
|
| 1037 | - } |
|
| 1038 | - // we can't actually setup rows in this loop yet cause we don't know all |
|
| 1039 | - // the unique tickets for this event yet (tickets are linked through all datetimes). |
|
| 1040 | - // So we're going to temporarily cache some of that information. |
|
| 1041 | - //loop through and setup the ticket rows and make sure the order is set. |
|
| 1042 | - foreach ($related_tickets as $ticket) { |
|
| 1043 | - $TKT_ID = $ticket->get('TKT_ID'); |
|
| 1044 | - $ticket_row = $ticket->get('TKT_row'); |
|
| 1045 | - //we only want unique tickets in our final display!! |
|
| 1046 | - if (! in_array($TKT_ID, $existing_ticket_ids, true)) { |
|
| 1047 | - $existing_ticket_ids[] = $TKT_ID; |
|
| 1048 | - $all_tickets[] = $ticket; |
|
| 1049 | - } |
|
| 1050 | - //temporary cache of this ticket info for this datetime for later processing of datetime rows. |
|
| 1051 | - $datetime_tickets[$DTT_ID][] = $ticket_row; |
|
| 1052 | - //temporary cache of this datetime info for this ticket for later processing of ticket rows. |
|
| 1053 | - if ( |
|
| 1054 | - ! isset($ticket_datetimes[$TKT_ID]) |
|
| 1055 | - || ! in_array($datetime_row, $ticket_datetimes[$TKT_ID], true) |
|
| 1056 | - ) { |
|
| 1057 | - $ticket_datetimes[$TKT_ID][] = $datetime_row; |
|
| 1058 | - } |
|
| 1059 | - } |
|
| 1060 | - $datetime_row++; |
|
| 1061 | - } |
|
| 1062 | - $main_template_args['total_ticket_rows'] = count($existing_ticket_ids); |
|
| 1063 | - $main_template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids); |
|
| 1064 | - $main_template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids); |
|
| 1065 | - //sort $all_tickets by order |
|
| 1066 | - usort( |
|
| 1067 | - $all_tickets, |
|
| 1068 | - function (EE_Ticket $a, EE_Ticket $b) { |
|
| 1069 | - $a_order = (int)$a->get('TKT_order'); |
|
| 1070 | - $b_order = (int)$b->get('TKT_order'); |
|
| 1071 | - if ($a_order === $b_order) { |
|
| 1072 | - return 0; |
|
| 1073 | - } |
|
| 1074 | - return ($a_order < $b_order) ? -1 : 1; |
|
| 1075 | - } |
|
| 1076 | - ); |
|
| 1077 | - // k NOW we have all the data we need for setting up the dtt rows |
|
| 1078 | - // and ticket rows so we start our dtt loop again. |
|
| 1079 | - $datetime_row = 1; |
|
| 1080 | - foreach ($datetimes as $datetime) { |
|
| 1081 | - $main_template_args['datetime_rows'] .= $this->_get_datetime_row( |
|
| 1082 | - $datetime_row, |
|
| 1083 | - $datetime, |
|
| 1084 | - $datetime_tickets, |
|
| 1085 | - $all_tickets, |
|
| 1086 | - false, |
|
| 1087 | - $datetimes |
|
| 1088 | - ); |
|
| 1089 | - $datetime_row++; |
|
| 1090 | - } |
|
| 1091 | - //then loop through all tickets for the ticket rows. |
|
| 1092 | - $ticket_row = 1; |
|
| 1093 | - foreach ($all_tickets as $ticket) { |
|
| 1094 | - $main_template_args['ticket_rows'] .= $this->_get_ticket_row( |
|
| 1095 | - $ticket_row, |
|
| 1096 | - $ticket, |
|
| 1097 | - $ticket_datetimes, |
|
| 1098 | - $datetimes, |
|
| 1099 | - false, |
|
| 1100 | - $all_tickets |
|
| 1101 | - ); |
|
| 1102 | - $ticket_row++; |
|
| 1103 | - } |
|
| 1104 | - $main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($datetimes, $all_tickets); |
|
| 1105 | - EEH_Template::display_template( |
|
| 1106 | - PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php', |
|
| 1107 | - $main_template_args |
|
| 1108 | - ); |
|
| 1109 | - } |
|
| 1110 | - |
|
| 1111 | - |
|
| 1112 | - |
|
| 1113 | - /** |
|
| 1114 | - * @param int $datetime_row |
|
| 1115 | - * @param EE_Datetime $datetime |
|
| 1116 | - * @param array $datetime_tickets |
|
| 1117 | - * @param array $all_tickets |
|
| 1118 | - * @param bool $default |
|
| 1119 | - * @param array $all_datetimes |
|
| 1120 | - * @return mixed |
|
| 1121 | - * @throws DomainException |
|
| 1122 | - * @throws EE_Error |
|
| 1123 | - */ |
|
| 1124 | - protected function _get_datetime_row( |
|
| 1125 | - $datetime_row, |
|
| 1126 | - EE_Datetime $datetime, |
|
| 1127 | - $datetime_tickets = array(), |
|
| 1128 | - $all_tickets = array(), |
|
| 1129 | - $default = false, |
|
| 1130 | - $all_datetimes = array() |
|
| 1131 | - ) { |
|
| 1132 | - $dtt_display_template_args = array( |
|
| 1133 | - 'dtt_edit_row' => $this->_get_dtt_edit_row($datetime_row, $datetime, $default, $all_datetimes), |
|
| 1134 | - 'dtt_attached_tickets_row' => $this->_get_dtt_attached_tickets_row( |
|
| 1135 | - $datetime_row, |
|
| 1136 | - $datetime, |
|
| 1137 | - $datetime_tickets, |
|
| 1138 | - $all_tickets, |
|
| 1139 | - $default |
|
| 1140 | - ), |
|
| 1141 | - 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
| 1142 | - ); |
|
| 1143 | - return EEH_Template::display_template( |
|
| 1144 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php', |
|
| 1145 | - $dtt_display_template_args, |
|
| 1146 | - true |
|
| 1147 | - ); |
|
| 1148 | - } |
|
| 1149 | - |
|
| 1150 | - |
|
| 1151 | - |
|
| 1152 | - /** |
|
| 1153 | - * This method is used to generate a dtt fields edit row. |
|
| 1154 | - * The same row is used to generate a row with valid DTT objects |
|
| 1155 | - * and the default row that is used as the skeleton by the js. |
|
| 1156 | - * |
|
| 1157 | - * @param int $datetime_row The row number for the row being generated. |
|
| 1158 | - * @param EE_Datetime $datetime |
|
| 1159 | - * @param bool $default Whether a default row is being generated or not. |
|
| 1160 | - * @param EE_Datetime[] $all_datetimes This is the array of all datetimes used in the editor. |
|
| 1161 | - * @return string |
|
| 1162 | - * @throws DomainException |
|
| 1163 | - * @throws EE_Error |
|
| 1164 | - */ |
|
| 1165 | - protected function _get_dtt_edit_row($datetime_row, $datetime, $default, $all_datetimes) |
|
| 1166 | - { |
|
| 1167 | - // if the incoming $datetime object is NOT an instance of EE_Datetime then force default to true. |
|
| 1168 | - $default = ! $datetime instanceof EE_Datetime ? true : $default; |
|
| 1169 | - $template_args = array( |
|
| 1170 | - 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
| 1171 | - 'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes', |
|
| 1172 | - 'edit_dtt_expanded' => '', |
|
| 1173 | - 'DTT_ID' => $default ? '' : $datetime->ID(), |
|
| 1174 | - 'DTT_name' => $default ? '' : $datetime->name(), |
|
| 1175 | - 'DTT_description' => $default ? '' : $datetime->description(), |
|
| 1176 | - 'DTT_EVT_start' => $default ? '' : $datetime->start_date($this->_date_time_format), |
|
| 1177 | - 'DTT_EVT_end' => $default ? '' : $datetime->end_date($this->_date_time_format), |
|
| 1178 | - 'DTT_reg_limit' => $default |
|
| 1179 | - ? '' |
|
| 1180 | - : $datetime->get_pretty( |
|
| 1181 | - 'DTT_reg_limit', |
|
| 1182 | - 'input' |
|
| 1183 | - ), |
|
| 1184 | - 'DTT_order' => $default ? 'DTTNUM' : $datetime_row, |
|
| 1185 | - 'dtt_sold' => $default ? '0' : $datetime->get('DTT_sold'), |
|
| 1186 | - 'dtt_reserved' => $default ? '0' : $datetime->reserved(), |
|
| 1187 | - 'clone_icon' => ! empty($datetime) && $datetime->get('DTT_sold') > 0 |
|
| 1188 | - ? '' |
|
| 1189 | - : 'clone-icon ee-icon ee-icon-clone clickable', |
|
| 1190 | - 'trash_icon' => ! empty($datetime) && $datetime->get('DTT_sold') > 0 |
|
| 1191 | - ? 'ee-lock-icon' |
|
| 1192 | - : 'trash-icon dashicons dashicons-post-trash clickable', |
|
| 1193 | - 'reg_list_url' => $default || ! $datetime->event() instanceof \EE_Event |
|
| 1194 | - ? '' |
|
| 1195 | - : EE_Admin_Page::add_query_args_and_nonce( |
|
| 1196 | - array('event_id' => $datetime->event()->ID(), 'datetime_id' => $datetime->ID()), |
|
| 1197 | - REG_ADMIN_URL |
|
| 1198 | - ), |
|
| 1199 | - ); |
|
| 1200 | - $template_args['show_trash'] = count($all_datetimes) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon' |
|
| 1201 | - ? ' style="display:none"' |
|
| 1202 | - : ''; |
|
| 1203 | - //allow filtering of template args at this point. |
|
| 1204 | - $template_args = apply_filters( |
|
| 1205 | - 'FHEE__espresso_events_Pricing_Hooks___get_dtt_edit_row__template_args', |
|
| 1206 | - $template_args, |
|
| 1207 | - $datetime_row, |
|
| 1208 | - $datetime, |
|
| 1209 | - $default, |
|
| 1210 | - $all_datetimes, |
|
| 1211 | - $this->_is_creating_event |
|
| 1212 | - ); |
|
| 1213 | - return EEH_Template::display_template( |
|
| 1214 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php', |
|
| 1215 | - $template_args, |
|
| 1216 | - true |
|
| 1217 | - ); |
|
| 1218 | - } |
|
| 1219 | - |
|
| 1220 | - |
|
| 1221 | - |
|
| 1222 | - /** |
|
| 1223 | - * @param int $datetime_row |
|
| 1224 | - * @param EE_Datetime $datetime |
|
| 1225 | - * @param array $datetime_tickets |
|
| 1226 | - * @param array $all_tickets |
|
| 1227 | - * @param bool $default |
|
| 1228 | - * @return mixed |
|
| 1229 | - * @throws DomainException |
|
| 1230 | - * @throws EE_Error |
|
| 1231 | - */ |
|
| 1232 | - protected function _get_dtt_attached_tickets_row( |
|
| 1233 | - $datetime_row, |
|
| 1234 | - $datetime, |
|
| 1235 | - $datetime_tickets = array(), |
|
| 1236 | - $all_tickets = array(), |
|
| 1237 | - $default |
|
| 1238 | - ) { |
|
| 1239 | - $template_args = array( |
|
| 1240 | - 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
| 1241 | - 'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes', |
|
| 1242 | - 'DTT_description' => $default ? '' : $datetime->description(), |
|
| 1243 | - 'datetime_tickets_list' => $default ? '<li class="hidden"></li>' : '', |
|
| 1244 | - 'show_tickets_row' => ' style="display:none;"', |
|
| 1245 | - 'add_new_datetime_ticket_help_link' => EEH_Template::get_help_tab_link( |
|
| 1246 | - 'add_new_ticket_via_datetime', |
|
| 1247 | - $this->_adminpage_obj->page_slug, |
|
| 1248 | - $this->_adminpage_obj->get_req_action(), |
|
| 1249 | - false, |
|
| 1250 | - false |
|
| 1251 | - ), |
|
| 1252 | - //todo need to add this help info id to the Events_Admin_Page core file so we can access it here. |
|
| 1253 | - 'DTT_ID' => $default ? '' : $datetime->ID(), |
|
| 1254 | - ); |
|
| 1255 | - //need to setup the list items (but only if this isn't a default skeleton setup) |
|
| 1256 | - if (! $default) { |
|
| 1257 | - $ticket_row = 1; |
|
| 1258 | - foreach ($all_tickets as $ticket) { |
|
| 1259 | - $template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
|
| 1260 | - $datetime_row, |
|
| 1261 | - $ticket_row, |
|
| 1262 | - $datetime, |
|
| 1263 | - $ticket, |
|
| 1264 | - $datetime_tickets, |
|
| 1265 | - $default |
|
| 1266 | - ); |
|
| 1267 | - $ticket_row++; |
|
| 1268 | - } |
|
| 1269 | - } |
|
| 1270 | - //filter template args at this point |
|
| 1271 | - $template_args = apply_filters( |
|
| 1272 | - 'FHEE__espresso_events_Pricing_Hooks___get_dtt_attached_ticket_row__template_args', |
|
| 1273 | - $template_args, |
|
| 1274 | - $datetime_row, |
|
| 1275 | - $datetime, |
|
| 1276 | - $datetime_tickets, |
|
| 1277 | - $all_tickets, |
|
| 1278 | - $default, |
|
| 1279 | - $this->_is_creating_event |
|
| 1280 | - ); |
|
| 1281 | - return EEH_Template::display_template( |
|
| 1282 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php', |
|
| 1283 | - $template_args, |
|
| 1284 | - true |
|
| 1285 | - ); |
|
| 1286 | - } |
|
| 1287 | - |
|
| 1288 | - |
|
| 1289 | - |
|
| 1290 | - /** |
|
| 1291 | - * @param int $datetime_row |
|
| 1292 | - * @param int $ticket_row |
|
| 1293 | - * @param EE_Datetime $datetime |
|
| 1294 | - * @param EE_Ticket $ticket |
|
| 1295 | - * @param array $datetime_tickets |
|
| 1296 | - * @param bool $default |
|
| 1297 | - * @return mixed |
|
| 1298 | - * @throws DomainException |
|
| 1299 | - * @throws EE_Error |
|
| 1300 | - */ |
|
| 1301 | - protected function _get_datetime_tickets_list_item( |
|
| 1302 | - $datetime_row, |
|
| 1303 | - $ticket_row, |
|
| 1304 | - $datetime, |
|
| 1305 | - $ticket, |
|
| 1306 | - $datetime_tickets = array(), |
|
| 1307 | - $default |
|
| 1308 | - ) { |
|
| 1309 | - $dtt_tkts = $datetime instanceof EE_Datetime && isset($datetime_tickets[$datetime->ID()]) |
|
| 1310 | - ? $datetime_tickets[$datetime->ID()] |
|
| 1311 | - : array(); |
|
| 1312 | - $display_row = $ticket instanceof EE_Ticket ? $ticket->get('TKT_row') : 0; |
|
| 1313 | - $no_ticket = $default && empty($ticket); |
|
| 1314 | - $template_args = array( |
|
| 1315 | - 'dtt_row' => $default |
|
| 1316 | - ? 'DTTNUM' |
|
| 1317 | - : $datetime_row, |
|
| 1318 | - 'tkt_row' => $no_ticket |
|
| 1319 | - ? 'TICKETNUM' |
|
| 1320 | - : $ticket_row, |
|
| 1321 | - 'datetime_ticket_checked' => in_array($display_row, $dtt_tkts, true) |
|
| 1322 | - ? ' checked="checked"' |
|
| 1323 | - : '', |
|
| 1324 | - 'ticket_selected' => in_array($display_row, $dtt_tkts, true) |
|
| 1325 | - ? ' ticket-selected' |
|
| 1326 | - : '', |
|
| 1327 | - 'TKT_name' => $no_ticket |
|
| 1328 | - ? 'TKTNAME' |
|
| 1329 | - : $ticket->get('TKT_name'), |
|
| 1330 | - 'tkt_status_class' => $no_ticket || $this->_is_creating_event |
|
| 1331 | - ? ' tkt-status-' . EE_Ticket::onsale |
|
| 1332 | - : ' tkt-status-' . $ticket->ticket_status(), |
|
| 1333 | - ); |
|
| 1334 | - //filter template args |
|
| 1335 | - $template_args = apply_filters( |
|
| 1336 | - 'FHEE__espresso_events_Pricing_Hooks___get_datetime_tickets_list_item__template_args', |
|
| 1337 | - $template_args, |
|
| 1338 | - $datetime_row, |
|
| 1339 | - $ticket_row, |
|
| 1340 | - $datetime, |
|
| 1341 | - $ticket, |
|
| 1342 | - $datetime_tickets, |
|
| 1343 | - $default, |
|
| 1344 | - $this->_is_creating_event |
|
| 1345 | - ); |
|
| 1346 | - return EEH_Template::display_template( |
|
| 1347 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php', |
|
| 1348 | - $template_args, |
|
| 1349 | - true |
|
| 1350 | - ); |
|
| 1351 | - } |
|
| 1352 | - |
|
| 1353 | - |
|
| 1354 | - |
|
| 1355 | - /** |
|
| 1356 | - * This generates the ticket row for tickets. |
|
| 1357 | - * This same method is used to generate both the actual rows and the js skeleton row |
|
| 1358 | - * (when default === true) |
|
| 1359 | - * |
|
| 1360 | - * @param int $ticket_row Represents the row number being generated. |
|
| 1361 | - * @param $ticket |
|
| 1362 | - * @param EE_Datetime[] $ticket_datetimes Either an array of all datetimes on all tickets indexed by each ticket |
|
| 1363 | - * or empty for default |
|
| 1364 | - * @param EE_Datetime[] $all_datetimes All Datetimes on the event or empty for default. |
|
| 1365 | - * @param bool $default Whether default row being generated or not. |
|
| 1366 | - * @param EE_Ticket[] $all_tickets This is an array of all tickets attached to the event |
|
| 1367 | - * (or empty in the case of defaults) |
|
| 1368 | - * @return mixed |
|
| 1369 | - * @throws DomainException |
|
| 1370 | - * @throws EE_Error |
|
| 1371 | - */ |
|
| 1372 | - protected function _get_ticket_row( |
|
| 1373 | - $ticket_row, |
|
| 1374 | - $ticket, |
|
| 1375 | - $ticket_datetimes, |
|
| 1376 | - $all_datetimes, |
|
| 1377 | - $default = false, |
|
| 1378 | - $all_tickets = array() |
|
| 1379 | - ) { |
|
| 1380 | - // if $ticket is not an instance of EE_Ticket then force default to true. |
|
| 1381 | - $default = ! $ticket instanceof EE_Ticket ? true : $default; |
|
| 1382 | - $prices = ! empty($ticket) && ! $default ? $ticket->get_many_related('Price', |
|
| 1383 | - array('default_where_conditions' => 'none', 'order_by' => array('PRC_order' => 'ASC'))) : array(); |
|
| 1384 | - // if there is only one price (which would be the base price) |
|
| 1385 | - // or NO prices and this ticket is a default ticket, |
|
| 1386 | - // let's just make sure there are no cached default prices on the object. |
|
| 1387 | - // This is done by not including any query_params. |
|
| 1388 | - if ($ticket instanceof EE_Ticket && $ticket->is_default() && (count($prices) === 1 || empty($prices))) { |
|
| 1389 | - $prices = $ticket->prices(); |
|
| 1390 | - } |
|
| 1391 | - // check if we're dealing with a default ticket in which case |
|
| 1392 | - // we don't want any starting_ticket_datetime_row values set |
|
| 1393 | - // (otherwise there won't be any new relationships created for tickets based off of the default ticket). |
|
| 1394 | - // This will future proof in case there is ever any behaviour change between what the primary_key defaults to. |
|
| 1395 | - $default_dtt = $default || ($ticket instanceof EE_Ticket && $ticket->is_default()); |
|
| 1396 | - $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()]) |
|
| 1397 | - ? $ticket_datetimes[$ticket->ID()] |
|
| 1398 | - : array(); |
|
| 1399 | - $ticket_subtotal = $default ? 0 : $ticket->get_ticket_subtotal(); |
|
| 1400 | - $base_price = $default ? null : $ticket->base_price(); |
|
| 1401 | - $count_price_mods = EEM_Price::instance()->get_all_default_prices(true); |
|
| 1402 | - //breaking out complicated condition for ticket_status |
|
| 1403 | - if ($default) { |
|
| 1404 | - $ticket_status_class = ' tkt-status-' . EE_Ticket::onsale; |
|
| 1405 | - } else { |
|
| 1406 | - $ticket_status_class = $ticket->is_default() |
|
| 1407 | - ? ' tkt-status-' . EE_Ticket::onsale |
|
| 1408 | - : ' tkt-status-' . $ticket->ticket_status(); |
|
| 1409 | - } |
|
| 1410 | - //breaking out complicated condition for TKT_taxable |
|
| 1411 | - if ($default) { |
|
| 1412 | - $TKT_taxable = ''; |
|
| 1413 | - } else { |
|
| 1414 | - $TKT_taxable = $ticket->taxable() |
|
| 1415 | - ? ' checked="checked"' |
|
| 1416 | - : ''; |
|
| 1417 | - } |
|
| 1418 | - if ($default) { |
|
| 1419 | - $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence'); |
|
| 1420 | - } elseif ($ticket->is_default()) { |
|
| 1421 | - $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence'); |
|
| 1422 | - } else { |
|
| 1423 | - $TKT_status = $ticket->ticket_status(true); |
|
| 1424 | - } |
|
| 1425 | - if ($default) { |
|
| 1426 | - $TKT_min = ''; |
|
| 1427 | - } else { |
|
| 1428 | - $TKT_min = $ticket->min(); |
|
| 1429 | - if ($TKT_min === -1 || $TKT_min === 0) { |
|
| 1430 | - $TKT_min = ''; |
|
| 1431 | - } |
|
| 1432 | - } |
|
| 1433 | - $template_args = array( |
|
| 1434 | - 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
| 1435 | - 'TKT_order' => $default ? 'TICKETNUM' : $ticket_row, |
|
| 1436 | - //on initial page load this will always be the correct order. |
|
| 1437 | - 'tkt_status_class' => $ticket_status_class, |
|
| 1438 | - 'display_edit_tkt_row' => ' style="display:none;"', |
|
| 1439 | - 'edit_tkt_expanded' => '', |
|
| 1440 | - 'edit_tickets_name' => $default ? 'TICKETNAMEATTR' : 'edit_tickets', |
|
| 1441 | - 'TKT_name' => $default ? '' : $ticket->name(), |
|
| 1442 | - 'TKT_start_date' => $default |
|
| 1443 | - ? '' |
|
| 1444 | - : $ticket->get_date('TKT_start_date', $this->_date_time_format), |
|
| 1445 | - 'TKT_end_date' => $default |
|
| 1446 | - ? '' |
|
| 1447 | - : $ticket->get_date('TKT_end_date', $this->_date_time_format), |
|
| 1448 | - 'TKT_status' => $TKT_status, |
|
| 1449 | - 'TKT_price' => $default |
|
| 1450 | - ? '' |
|
| 1451 | - : EEH_Template::format_currency( |
|
| 1452 | - $ticket->get_ticket_total_with_taxes(), |
|
| 1453 | - false, |
|
| 1454 | - false |
|
| 1455 | - ), |
|
| 1456 | - 'TKT_price_code' => EE_Registry::instance()->CFG->currency->code, |
|
| 1457 | - 'TKT_price_amount' => $default ? 0 : $ticket_subtotal, |
|
| 1458 | - 'TKT_qty' => $default |
|
| 1459 | - ? '' |
|
| 1460 | - : $ticket->get_pretty('TKT_qty', 'symbol'), |
|
| 1461 | - 'TKT_qty_for_input' => $default |
|
| 1462 | - ? '' |
|
| 1463 | - : $ticket->get_pretty('TKT_qty', 'input'), |
|
| 1464 | - 'TKT_uses' => $default |
|
| 1465 | - ? '' |
|
| 1466 | - : $ticket->get_pretty('TKT_uses', 'input'), |
|
| 1467 | - 'TKT_min' => $TKT_min, |
|
| 1468 | - 'TKT_max' => $default |
|
| 1469 | - ? '' |
|
| 1470 | - : $ticket->get_pretty('TKT_max', 'input'), |
|
| 1471 | - 'TKT_sold' => $default ? 0 : $ticket->tickets_sold('ticket'), |
|
| 1472 | - 'TKT_reserved' => $default ? 0 : $ticket->reserved(), |
|
| 1473 | - 'TKT_registrations' => $default |
|
| 1474 | - ? 0 |
|
| 1475 | - : $ticket->count_registrations( |
|
| 1476 | - array( |
|
| 1477 | - array( |
|
| 1478 | - 'STS_ID' => array( |
|
| 1479 | - '!=', |
|
| 1480 | - EEM_Registration::status_id_incomplete, |
|
| 1481 | - ), |
|
| 1482 | - ), |
|
| 1483 | - ) |
|
| 1484 | - ), |
|
| 1485 | - 'TKT_ID' => $default ? 0 : $ticket->ID(), |
|
| 1486 | - 'TKT_description' => $default ? '' : $ticket->description(), |
|
| 1487 | - 'TKT_is_default' => $default ? 0 : $ticket->is_default(), |
|
| 1488 | - 'TKT_required' => $default ? 0 : $ticket->required(), |
|
| 1489 | - 'TKT_is_default_selector' => '', |
|
| 1490 | - 'ticket_price_rows' => '', |
|
| 1491 | - 'TKT_base_price' => $default || ! $base_price instanceof EE_Price |
|
| 1492 | - ? '' |
|
| 1493 | - : $base_price->get_pretty('PRC_amount', 'localized_float'), |
|
| 1494 | - 'TKT_base_price_ID' => $default || ! $base_price instanceof EE_Price ? 0 : $base_price->ID(), |
|
| 1495 | - 'show_price_modifier' => count($prices) > 1 || ($default && $count_price_mods > 0) |
|
| 1496 | - ? '' |
|
| 1497 | - : ' style="display:none;"', |
|
| 1498 | - 'show_price_mod_button' => count($prices) > 1 |
|
| 1499 | - || ($default && $count_price_mods > 0) |
|
| 1500 | - || (! $default && $ticket->deleted()) |
|
| 1501 | - ? ' style="display:none;"' |
|
| 1502 | - : '', |
|
| 1503 | - 'total_price_rows' => count($prices) > 1 ? count($prices) : 1, |
|
| 1504 | - 'ticket_datetimes_list' => $default ? '<li class="hidden"></li>' : '', |
|
| 1505 | - 'starting_ticket_datetime_rows' => $default || $default_dtt ? '' : implode(',', $tkt_datetimes), |
|
| 1506 | - 'ticket_datetime_rows' => $default ? '' : implode(',', $tkt_datetimes), |
|
| 1507 | - 'existing_ticket_price_ids' => $default ? '' : implode(',', array_keys($prices)), |
|
| 1508 | - 'ticket_template_id' => $default ? 0 : $ticket->get('TTM_ID'), |
|
| 1509 | - 'TKT_taxable' => $TKT_taxable, |
|
| 1510 | - 'display_subtotal' => $ticket instanceof EE_Ticket && $ticket->taxable() |
|
| 1511 | - ? '' |
|
| 1512 | - : ' style="display:none"', |
|
| 1513 | - 'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign, |
|
| 1514 | - 'TKT_subtotal_amount_display' => EEH_Template::format_currency( |
|
| 1515 | - $ticket_subtotal, |
|
| 1516 | - false, |
|
| 1517 | - false |
|
| 1518 | - ), |
|
| 1519 | - 'TKT_subtotal_amount' => $ticket_subtotal, |
|
| 1520 | - 'tax_rows' => $this->_get_tax_rows($ticket_row, $ticket), |
|
| 1521 | - 'disabled' => $ticket instanceof EE_Ticket && $ticket->deleted(), |
|
| 1522 | - 'ticket_archive_class' => $ticket instanceof EE_Ticket && $ticket->deleted() |
|
| 1523 | - ? ' ticket-archived' |
|
| 1524 | - : '', |
|
| 1525 | - 'trash_icon' => $ticket instanceof EE_Ticket |
|
| 1526 | - && $ticket->deleted() |
|
| 1527 | - && ! $ticket->is_permanently_deleteable() |
|
| 1528 | - ? 'ee-lock-icon ' |
|
| 1529 | - : 'trash-icon dashicons dashicons-post-trash clickable', |
|
| 1530 | - 'clone_icon' => $ticket instanceof EE_Ticket && $ticket->deleted() |
|
| 1531 | - ? '' |
|
| 1532 | - : 'clone-icon ee-icon ee-icon-clone clickable', |
|
| 1533 | - ); |
|
| 1534 | - $template_args['trash_hidden'] = count($all_tickets) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon' |
|
| 1535 | - ? ' style="display:none"' |
|
| 1536 | - : ''; |
|
| 1537 | - //handle rows that should NOT be empty |
|
| 1538 | - if (empty($template_args['TKT_start_date'])) { |
|
| 1539 | - //if empty then the start date will be now. |
|
| 1540 | - $template_args['TKT_start_date'] = date($this->_date_time_format, |
|
| 1541 | - current_time('timestamp')); |
|
| 1542 | - $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
| 1543 | - } |
|
| 1544 | - if (empty($template_args['TKT_end_date'])) { |
|
| 1545 | - //get the earliest datetime (if present); |
|
| 1546 | - $earliest_dtt = $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 |
|
| 1547 | - ? $this->_adminpage_obj->get_cpt_model_obj()->get_first_related( |
|
| 1548 | - 'Datetime', |
|
| 1549 | - array('order_by' => array('DTT_EVT_start' => 'ASC')) |
|
| 1550 | - ) |
|
| 1551 | - : null; |
|
| 1552 | - if (! empty($earliest_dtt)) { |
|
| 1553 | - $template_args['TKT_end_date'] = $earliest_dtt->get_datetime( |
|
| 1554 | - 'DTT_EVT_start', |
|
| 1555 | - $this->_date_time_format |
|
| 1556 | - ); |
|
| 1557 | - } else { |
|
| 1558 | - //default so let's just use what's been set for the default date-time which is 30 days from now. |
|
| 1559 | - $template_args['TKT_end_date'] = date( |
|
| 1560 | - $this->_date_time_format, |
|
| 1561 | - mktime(24, 0, 0, date('m'), date('d') + 29, date('Y') |
|
| 1562 | - ) |
|
| 1563 | - ); |
|
| 1564 | - } |
|
| 1565 | - $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
| 1566 | - } |
|
| 1567 | - //generate ticket_datetime items |
|
| 1568 | - if (! $default) { |
|
| 1569 | - $datetime_row = 1; |
|
| 1570 | - foreach ($all_datetimes as $datetime) { |
|
| 1571 | - $template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
|
| 1572 | - $datetime_row, |
|
| 1573 | - $ticket_row, |
|
| 1574 | - $datetime, |
|
| 1575 | - $ticket, |
|
| 1576 | - $ticket_datetimes, |
|
| 1577 | - $default |
|
| 1578 | - ); |
|
| 1579 | - $datetime_row++; |
|
| 1580 | - } |
|
| 1581 | - } |
|
| 1582 | - $price_row = 1; |
|
| 1583 | - foreach ($prices as $price) { |
|
| 1584 | - if (! $price instanceof EE_Price) { |
|
| 1585 | - continue; |
|
| 1586 | - } |
|
| 1587 | - if ($price->is_base_price()) { |
|
| 1588 | - $price_row++; |
|
| 1589 | - continue; |
|
| 1590 | - } |
|
| 1591 | - $show_trash = !((count($prices) > 1 && $price_row === 1) || count($prices) === 1); |
|
| 1592 | - $show_create = !(count($prices) > 1 && count($prices) !== $price_row); |
|
| 1593 | - $template_args['ticket_price_rows'] .= $this->_get_ticket_price_row( |
|
| 1594 | - $ticket_row, |
|
| 1595 | - $price_row, |
|
| 1596 | - $price, |
|
| 1597 | - $default, |
|
| 1598 | - $ticket, |
|
| 1599 | - $show_trash, |
|
| 1600 | - $show_create |
|
| 1601 | - ); |
|
| 1602 | - $price_row++; |
|
| 1603 | - } |
|
| 1604 | - //filter $template_args |
|
| 1605 | - $template_args = apply_filters( |
|
| 1606 | - 'FHEE__espresso_events_Pricing_Hooks___get_ticket_row__template_args', |
|
| 1607 | - $template_args, |
|
| 1608 | - $ticket_row, |
|
| 1609 | - $ticket, |
|
| 1610 | - $ticket_datetimes, |
|
| 1611 | - $all_datetimes, |
|
| 1612 | - $default, |
|
| 1613 | - $all_tickets, |
|
| 1614 | - $this->_is_creating_event |
|
| 1615 | - ); |
|
| 1616 | - return EEH_Template::display_template( |
|
| 1617 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php', |
|
| 1618 | - $template_args, |
|
| 1619 | - true |
|
| 1620 | - ); |
|
| 1621 | - } |
|
| 1622 | - |
|
| 1623 | - |
|
| 1624 | - |
|
| 1625 | - /** |
|
| 1626 | - * @param int $ticket_row |
|
| 1627 | - * @param EE_Ticket|null $ticket |
|
| 1628 | - * @return string |
|
| 1629 | - * @throws DomainException |
|
| 1630 | - * @throws EE_Error |
|
| 1631 | - */ |
|
| 1632 | - protected function _get_tax_rows($ticket_row, $ticket) |
|
| 1633 | - { |
|
| 1634 | - $tax_rows = ''; |
|
| 1635 | - /** @var EE_Price[] $taxes */ |
|
| 1636 | - $taxes = empty($ticket) ? EE_Taxes::get_taxes_for_admin() : $ticket->get_ticket_taxes_for_admin(); |
|
| 1637 | - foreach ($taxes as $tax) { |
|
| 1638 | - $tax_added = $this->_get_tax_added($tax, $ticket); |
|
| 1639 | - $template_args = array( |
|
| 1640 | - 'display_tax' => ! empty($ticket) && $ticket->get('TKT_taxable') |
|
| 1641 | - ? '' |
|
| 1642 | - : ' style="display:none;"', |
|
| 1643 | - 'tax_id' => $tax->ID(), |
|
| 1644 | - 'tkt_row' => $ticket_row, |
|
| 1645 | - 'tax_label' => $tax->get('PRC_name'), |
|
| 1646 | - 'tax_added' => $tax_added, |
|
| 1647 | - 'tax_added_display' => EEH_Template::format_currency($tax_added, false, false), |
|
| 1648 | - 'tax_amount' => $tax->get('PRC_amount'), |
|
| 1649 | - ); |
|
| 1650 | - $template_args = apply_filters( |
|
| 1651 | - 'FHEE__espresso_events_Pricing_Hooks___get_tax_rows__template_args', |
|
| 1652 | - $template_args, |
|
| 1653 | - $ticket_row, |
|
| 1654 | - $ticket, |
|
| 1655 | - $this->_is_creating_event |
|
| 1656 | - ); |
|
| 1657 | - $tax_rows .= EEH_Template::display_template( |
|
| 1658 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php', |
|
| 1659 | - $template_args, |
|
| 1660 | - true |
|
| 1661 | - ); |
|
| 1662 | - } |
|
| 1663 | - return $tax_rows; |
|
| 1664 | - } |
|
| 1665 | - |
|
| 1666 | - |
|
| 1667 | - |
|
| 1668 | - /** |
|
| 1669 | - * @param EE_Price $tax |
|
| 1670 | - * @param EE_Ticket|null $ticket |
|
| 1671 | - * @return float|int |
|
| 1672 | - * @throws EE_Error |
|
| 1673 | - */ |
|
| 1674 | - protected function _get_tax_added(EE_Price $tax, $ticket) |
|
| 1675 | - { |
|
| 1676 | - $subtotal = empty($ticket) ? 0 : $ticket->get_ticket_subtotal(); |
|
| 1677 | - return $subtotal * $tax->get('PRC_amount') / 100; |
|
| 1678 | - } |
|
| 1679 | - |
|
| 1680 | - |
|
| 1681 | - |
|
| 1682 | - /** |
|
| 1683 | - * @param int $ticket_row |
|
| 1684 | - * @param int $price_row |
|
| 1685 | - * @param EE_Price|null $price |
|
| 1686 | - * @param bool $default |
|
| 1687 | - * @param EE_Ticket|null $ticket |
|
| 1688 | - * @param bool $show_trash |
|
| 1689 | - * @param bool $show_create |
|
| 1690 | - * @return mixed |
|
| 1691 | - * @throws DomainException |
|
| 1692 | - * @throws EE_Error |
|
| 1693 | - */ |
|
| 1694 | - protected function _get_ticket_price_row( |
|
| 1695 | - $ticket_row, |
|
| 1696 | - $price_row, |
|
| 1697 | - $price, |
|
| 1698 | - $default, |
|
| 1699 | - $ticket, |
|
| 1700 | - $show_trash = true, |
|
| 1701 | - $show_create = true |
|
| 1702 | - ) { |
|
| 1703 | - $send_disabled = ! empty($ticket) && $ticket->get('TKT_deleted'); |
|
| 1704 | - $template_args = array( |
|
| 1705 | - 'tkt_row' => $default && empty($ticket) |
|
| 1706 | - ? 'TICKETNUM' |
|
| 1707 | - : $ticket_row, |
|
| 1708 | - 'PRC_order' => $default && empty($price) |
|
| 1709 | - ? 'PRICENUM' |
|
| 1710 | - : $price_row, |
|
| 1711 | - 'edit_prices_name' => $default && empty($price) |
|
| 1712 | - ? 'PRICENAMEATTR' |
|
| 1713 | - : 'edit_prices', |
|
| 1714 | - 'price_type_selector' => $default && empty($price) |
|
| 1715 | - ? $this->_get_base_price_template($ticket_row, $price_row, $price, $default) |
|
| 1716 | - : $this->_get_price_type_selector($ticket_row, $price_row, $price, $default, $send_disabled), |
|
| 1717 | - 'PRC_ID' => $default && empty($price) |
|
| 1718 | - ? 0 |
|
| 1719 | - : $price->ID(), |
|
| 1720 | - 'PRC_is_default' => $default && empty($price) |
|
| 1721 | - ? 0 |
|
| 1722 | - : $price->get('PRC_is_default'), |
|
| 1723 | - 'PRC_name' => $default && empty($price) |
|
| 1724 | - ? '' |
|
| 1725 | - : $price->get('PRC_name'), |
|
| 1726 | - 'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign, |
|
| 1727 | - 'show_plus_or_minus' => $default && empty($price) |
|
| 1728 | - ? '' |
|
| 1729 | - : ' style="display:none;"', |
|
| 1730 | - 'show_plus' => ($default && empty($price)) || ($price->is_discount() || $price->is_base_price()) |
|
| 1731 | - ? ' style="display:none;"' |
|
| 1732 | - : '', |
|
| 1733 | - 'show_minus' => ($default && empty($price)) || ! $price->is_discount() |
|
| 1734 | - ? ' style="display:none;"' |
|
| 1735 | - : '', |
|
| 1736 | - 'show_currency_symbol' => ($default && empty($price)) || $price->is_percent() |
|
| 1737 | - ? ' style="display:none"' |
|
| 1738 | - : '', |
|
| 1739 | - 'PRC_amount' => $default && empty($price) |
|
| 1740 | - ? 0 |
|
| 1741 | - : $price->get_pretty('PRC_amount', |
|
| 1742 | - 'localized_float'), |
|
| 1743 | - 'show_percentage' => ($default && empty($price)) || ! $price->is_percent() |
|
| 1744 | - ? ' style="display:none;"' |
|
| 1745 | - : '', |
|
| 1746 | - 'show_trash_icon' => $show_trash |
|
| 1747 | - ? '' |
|
| 1748 | - : ' style="display:none;"', |
|
| 1749 | - 'show_create_button' => $show_create |
|
| 1750 | - ? '' |
|
| 1751 | - : ' style="display:none;"', |
|
| 1752 | - 'PRC_desc' => $default && empty($price) |
|
| 1753 | - ? '' |
|
| 1754 | - : $price->get('PRC_desc'), |
|
| 1755 | - 'disabled' => ! empty($ticket) && $ticket->get('TKT_deleted'), |
|
| 1756 | - ); |
|
| 1757 | - $template_args = apply_filters( |
|
| 1758 | - 'FHEE__espresso_events_Pricing_Hooks___get_ticket_price_row__template_args', |
|
| 1759 | - $template_args, |
|
| 1760 | - $ticket_row, |
|
| 1761 | - $price_row, |
|
| 1762 | - $price, |
|
| 1763 | - $default, |
|
| 1764 | - $ticket, |
|
| 1765 | - $show_trash, |
|
| 1766 | - $show_create, |
|
| 1767 | - $this->_is_creating_event |
|
| 1768 | - ); |
|
| 1769 | - return EEH_Template::display_template( |
|
| 1770 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php', |
|
| 1771 | - $template_args, |
|
| 1772 | - true |
|
| 1773 | - ); |
|
| 1774 | - } |
|
| 1775 | - |
|
| 1776 | - |
|
| 1777 | - |
|
| 1778 | - /** |
|
| 1779 | - * @param int $ticket_row |
|
| 1780 | - * @param int $price_row |
|
| 1781 | - * @param EE_Price $price |
|
| 1782 | - * @param bool $default |
|
| 1783 | - * @param bool $disabled |
|
| 1784 | - * @return mixed |
|
| 1785 | - * @throws DomainException |
|
| 1786 | - * @throws EE_Error |
|
| 1787 | - */ |
|
| 1788 | - protected function _get_price_type_selector($ticket_row, $price_row, $price, $default, $disabled = false) |
|
| 1789 | - { |
|
| 1790 | - if ($price->is_base_price()) { |
|
| 1791 | - return $this->_get_base_price_template($ticket_row, $price_row, $price, $default); |
|
| 1792 | - } |
|
| 1793 | - return $this->_get_price_modifier_template($ticket_row, $price_row, $price, $default, $disabled); |
|
| 1794 | - } |
|
| 1795 | - |
|
| 1796 | - |
|
| 1797 | - |
|
| 1798 | - /** |
|
| 1799 | - * @param int $ticket_row |
|
| 1800 | - * @param int $price_row |
|
| 1801 | - * @param EE_Price $price |
|
| 1802 | - * @param bool $default |
|
| 1803 | - * @return mixed |
|
| 1804 | - * @throws DomainException |
|
| 1805 | - * @throws EE_Error |
|
| 1806 | - */ |
|
| 1807 | - protected function _get_base_price_template($ticket_row, $price_row, $price, $default) |
|
| 1808 | - { |
|
| 1809 | - $template_args = array( |
|
| 1810 | - 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
| 1811 | - 'PRC_order' => $default && empty($price) ? 'PRICENUM' : $price_row, |
|
| 1812 | - 'PRT_ID' => $default && empty($price) ? 1 : $price->get('PRT_ID'), |
|
| 1813 | - 'PRT_name' => esc_html__('Price', 'event_espresso'), |
|
| 1814 | - 'price_selected_operator' => '+', |
|
| 1815 | - 'price_selected_is_percent' => 0, |
|
| 1816 | - ); |
|
| 1817 | - $template_args = apply_filters( |
|
| 1818 | - 'FHEE__espresso_events_Pricing_Hooks___get_base_price_template__template_args', |
|
| 1819 | - $template_args, |
|
| 1820 | - $ticket_row, |
|
| 1821 | - $price_row, |
|
| 1822 | - $price, |
|
| 1823 | - $default, |
|
| 1824 | - $this->_is_creating_event |
|
| 1825 | - ); |
|
| 1826 | - return EEH_Template::display_template( |
|
| 1827 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php', |
|
| 1828 | - $template_args, |
|
| 1829 | - true |
|
| 1830 | - ); |
|
| 1831 | - } |
|
| 1832 | - |
|
| 1833 | - |
|
| 1834 | - |
|
| 1835 | - /** |
|
| 1836 | - * @param int $ticket_row |
|
| 1837 | - * @param int $price_row |
|
| 1838 | - * @param EE_Price $price |
|
| 1839 | - * @param bool $default |
|
| 1840 | - * @param bool $disabled |
|
| 1841 | - * @return mixed |
|
| 1842 | - * @throws DomainException |
|
| 1843 | - * @throws EE_Error |
|
| 1844 | - */ |
|
| 1845 | - protected function _get_price_modifier_template( |
|
| 1846 | - $ticket_row, |
|
| 1847 | - $price_row, |
|
| 1848 | - $price, |
|
| 1849 | - $default, |
|
| 1850 | - $disabled = false |
|
| 1851 | - ) { |
|
| 1852 | - $select_name = $default && ! $price instanceof EE_Price |
|
| 1853 | - ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]' |
|
| 1854 | - : 'edit_prices[' . $ticket_row . '][' . $price_row . '][PRT_ID]'; |
|
| 1855 | - /** @var EEM_Price_Type $price_type_model */ |
|
| 1856 | - $price_type_model = EE_Registry::instance()->load_model('Price_Type'); |
|
| 1857 | - $price_types = $price_type_model->get_all(array( |
|
| 1858 | - array( |
|
| 1859 | - 'OR' => array( |
|
| 1860 | - 'PBT_ID' => '2', |
|
| 1861 | - 'PBT_ID*' => '3', |
|
| 1862 | - ), |
|
| 1863 | - ), |
|
| 1864 | - )); |
|
| 1865 | - $all_price_types = $default && ! $price instanceof EE_Price |
|
| 1866 | - ? array(esc_html__('Select Modifier', 'event_espresso')) |
|
| 1867 | - : array(); |
|
| 1868 | - $selected_price_type_id = $default && ! $price instanceof EE_Price ? 0 : $price->type(); |
|
| 1869 | - $price_option_spans = ''; |
|
| 1870 | - //setup price types for selector |
|
| 1871 | - foreach ($price_types as $price_type) { |
|
| 1872 | - if (! $price_type instanceof EE_Price_Type) { |
|
| 1873 | - continue; |
|
| 1874 | - } |
|
| 1875 | - $all_price_types[$price_type->ID()] = $price_type->get('PRT_name'); |
|
| 1876 | - //while we're in the loop let's setup the option spans used by js |
|
| 1877 | - $span_args = array( |
|
| 1878 | - 'PRT_ID' => $price_type->ID(), |
|
| 1879 | - 'PRT_operator' => $price_type->is_discount() ? '-' : '+', |
|
| 1880 | - 'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0, |
|
| 1881 | - ); |
|
| 1882 | - $price_option_spans .= EEH_Template::display_template( |
|
| 1883 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php', |
|
| 1884 | - $span_args, |
|
| 1885 | - true |
|
| 1886 | - ); |
|
| 1887 | - } |
|
| 1888 | - $select_name = $disabled ? 'archive_price[' . $ticket_row . '][' . $price_row . '][PRT_ID]' : $select_name; |
|
| 1889 | - $select_input = new EE_Select_Input( |
|
| 1890 | - $all_price_types, |
|
| 1891 | - array( |
|
| 1892 | - 'default' => $selected_price_type_id, |
|
| 1893 | - 'html_name' => $select_name, |
|
| 1894 | - 'html_class' => 'edit-price-PRT_ID', |
|
| 1895 | - 'html_other_attributes' => $disabled ? 'style="width:auto;" disabled' : 'style="width:auto;"', |
|
| 1896 | - ) |
|
| 1897 | - ); |
|
| 1898 | - $price_selected_operator = $price instanceof EE_Price && $price->is_discount() ? '-' : '+'; |
|
| 1899 | - $price_selected_operator = $default && ! $price instanceof EE_Price ? '' : $price_selected_operator; |
|
| 1900 | - $price_selected_is_percent = $price instanceof EE_Price && $price->is_percent() ? 1 : 0; |
|
| 1901 | - $price_selected_is_percent = $default && ! $price instanceof EE_Price ? '' : $price_selected_is_percent; |
|
| 1902 | - $template_args = array( |
|
| 1903 | - 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
| 1904 | - 'PRC_order' => $default && ! $price instanceof EE_Price ? 'PRICENUM' : $price_row, |
|
| 1905 | - 'price_modifier_selector' => $select_input->get_html_for_input(), |
|
| 1906 | - 'main_name' => $select_name, |
|
| 1907 | - 'selected_price_type_id' => $selected_price_type_id, |
|
| 1908 | - 'price_option_spans' => $price_option_spans, |
|
| 1909 | - 'price_selected_operator' => $price_selected_operator, |
|
| 1910 | - 'price_selected_is_percent' => $price_selected_is_percent, |
|
| 1911 | - 'disabled' => $disabled, |
|
| 1912 | - ); |
|
| 1913 | - $template_args = apply_filters( |
|
| 1914 | - 'FHEE__espresso_events_Pricing_Hooks___get_price_modifier_template__template_args', |
|
| 1915 | - $template_args, |
|
| 1916 | - $ticket_row, |
|
| 1917 | - $price_row, |
|
| 1918 | - $price, |
|
| 1919 | - $default, |
|
| 1920 | - $disabled, |
|
| 1921 | - $this->_is_creating_event |
|
| 1922 | - ); |
|
| 1923 | - return EEH_Template::display_template( |
|
| 1924 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php', |
|
| 1925 | - $template_args, |
|
| 1926 | - true |
|
| 1927 | - ); |
|
| 1928 | - } |
|
| 1929 | - |
|
| 1930 | - |
|
| 1931 | - |
|
| 1932 | - /** |
|
| 1933 | - * @param int $datetime_row |
|
| 1934 | - * @param int $ticket_row |
|
| 1935 | - * @param EE_Datetime|null $datetime |
|
| 1936 | - * @param EE_Ticket|null $ticket |
|
| 1937 | - * @param array $ticket_datetimes |
|
| 1938 | - * @param bool $default |
|
| 1939 | - * @return mixed |
|
| 1940 | - * @throws DomainException |
|
| 1941 | - * @throws EE_Error |
|
| 1942 | - */ |
|
| 1943 | - protected function _get_ticket_datetime_list_item( |
|
| 1944 | - $datetime_row, |
|
| 1945 | - $ticket_row, |
|
| 1946 | - $datetime, |
|
| 1947 | - $ticket, |
|
| 1948 | - $ticket_datetimes = array(), |
|
| 1949 | - $default |
|
| 1950 | - ) { |
|
| 1951 | - $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()]) |
|
| 1952 | - ? $ticket_datetimes[$ticket->ID()] |
|
| 1953 | - : array(); |
|
| 1954 | - $template_args = array( |
|
| 1955 | - 'dtt_row' => $default && ! $datetime instanceof EE_Datetime |
|
| 1956 | - ? 'DTTNUM' |
|
| 1957 | - : $datetime_row, |
|
| 1958 | - 'tkt_row' => $default |
|
| 1959 | - ? 'TICKETNUM' |
|
| 1960 | - : $ticket_row, |
|
| 1961 | - 'ticket_datetime_selected' => in_array($datetime_row, $tkt_datetimes, true) |
|
| 1962 | - ? ' ticket-selected' |
|
| 1963 | - : '', |
|
| 1964 | - 'ticket_datetime_checked' => in_array($datetime_row, $tkt_datetimes, true) |
|
| 1965 | - ? ' checked="checked"' |
|
| 1966 | - : '', |
|
| 1967 | - 'DTT_name' => $default && empty($datetime) |
|
| 1968 | - ? 'DTTNAME' |
|
| 1969 | - : $datetime->get_dtt_display_name(true), |
|
| 1970 | - 'tkt_status_class' => '', |
|
| 1971 | - ); |
|
| 1972 | - $template_args = apply_filters( |
|
| 1973 | - 'FHEE__espresso_events_Pricing_Hooks___get_ticket_datetime_list_item__template_args', |
|
| 1974 | - $template_args, |
|
| 1975 | - $datetime_row, |
|
| 1976 | - $ticket_row, |
|
| 1977 | - $datetime, |
|
| 1978 | - $ticket, |
|
| 1979 | - $ticket_datetimes, |
|
| 1980 | - $default, |
|
| 1981 | - $this->_is_creating_event |
|
| 1982 | - ); |
|
| 1983 | - return EEH_Template::display_template( |
|
| 1984 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php', |
|
| 1985 | - $template_args, |
|
| 1986 | - true |
|
| 1987 | - ); |
|
| 1988 | - } |
|
| 1989 | - |
|
| 1990 | - |
|
| 1991 | - |
|
| 1992 | - /** |
|
| 1993 | - * @param array $all_datetimes |
|
| 1994 | - * @param array $all_tickets |
|
| 1995 | - * @return mixed |
|
| 1996 | - * @throws DomainException |
|
| 1997 | - * @throws EE_Error |
|
| 1998 | - */ |
|
| 1999 | - protected function _get_ticket_js_structure($all_datetimes = array(), $all_tickets = array()) |
|
| 2000 | - { |
|
| 2001 | - $template_args = array( |
|
| 2002 | - 'default_datetime_edit_row' => $this->_get_dtt_edit_row( |
|
| 2003 | - 'DTTNUM', |
|
| 2004 | - null, |
|
| 2005 | - true, |
|
| 2006 | - $all_datetimes |
|
| 2007 | - ), |
|
| 2008 | - 'default_ticket_row' => $this->_get_ticket_row( |
|
| 2009 | - 'TICKETNUM', |
|
| 2010 | - null, |
|
| 2011 | - array(), |
|
| 2012 | - array(), |
|
| 2013 | - true |
|
| 2014 | - ), |
|
| 2015 | - 'default_price_row' => $this->_get_ticket_price_row( |
|
| 2016 | - 'TICKETNUM', |
|
| 2017 | - 'PRICENUM', |
|
| 2018 | - null, |
|
| 2019 | - true, |
|
| 2020 | - null |
|
| 2021 | - ), |
|
| 2022 | - 'default_price_rows' => '', |
|
| 2023 | - 'default_base_price_amount' => 0, |
|
| 2024 | - 'default_base_price_name' => '', |
|
| 2025 | - 'default_base_price_description' => '', |
|
| 2026 | - 'default_price_modifier_selector_row' => $this->_get_price_modifier_template( |
|
| 2027 | - 'TICKETNUM', |
|
| 2028 | - 'PRICENUM', |
|
| 2029 | - null, |
|
| 2030 | - true |
|
| 2031 | - ), |
|
| 2032 | - 'default_available_tickets_for_datetime' => $this->_get_dtt_attached_tickets_row( |
|
| 2033 | - 'DTTNUM', |
|
| 2034 | - null, |
|
| 2035 | - array(), |
|
| 2036 | - array(), |
|
| 2037 | - true |
|
| 2038 | - ), |
|
| 2039 | - 'existing_available_datetime_tickets_list' => '', |
|
| 2040 | - 'existing_available_ticket_datetimes_list' => '', |
|
| 2041 | - 'new_available_datetime_ticket_list_item' => $this->_get_datetime_tickets_list_item( |
|
| 2042 | - 'DTTNUM', |
|
| 2043 | - 'TICKETNUM', |
|
| 2044 | - null, |
|
| 2045 | - null, |
|
| 2046 | - array(), |
|
| 2047 | - true |
|
| 2048 | - ), |
|
| 2049 | - 'new_available_ticket_datetime_list_item' => $this->_get_ticket_datetime_list_item( |
|
| 2050 | - 'DTTNUM', |
|
| 2051 | - 'TICKETNUM', |
|
| 2052 | - null, |
|
| 2053 | - null, |
|
| 2054 | - array(), |
|
| 2055 | - true |
|
| 2056 | - ), |
|
| 2057 | - ); |
|
| 2058 | - $ticket_row = 1; |
|
| 2059 | - foreach ($all_tickets as $ticket) { |
|
| 2060 | - $template_args['existing_available_datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
|
| 2061 | - 'DTTNUM', |
|
| 2062 | - $ticket_row, |
|
| 2063 | - null, |
|
| 2064 | - $ticket, |
|
| 2065 | - array(), |
|
| 2066 | - true |
|
| 2067 | - ); |
|
| 2068 | - $ticket_row++; |
|
| 2069 | - } |
|
| 2070 | - $datetime_row = 1; |
|
| 2071 | - foreach ($all_datetimes as $datetime) { |
|
| 2072 | - $template_args['existing_available_ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
|
| 2073 | - $datetime_row, |
|
| 2074 | - 'TICKETNUM', |
|
| 2075 | - $datetime, |
|
| 2076 | - null, |
|
| 2077 | - array(), |
|
| 2078 | - true |
|
| 2079 | - ); |
|
| 2080 | - $datetime_row++; |
|
| 2081 | - } |
|
| 2082 | - /** @var EEM_Price $price_model */ |
|
| 2083 | - $price_model = EE_Registry::instance()->load_model('Price'); |
|
| 2084 | - $default_prices = $price_model->get_all_default_prices(); |
|
| 2085 | - $price_row = 1; |
|
| 2086 | - foreach ($default_prices as $price) { |
|
| 2087 | - if (! $price instanceof EE_Price) { |
|
| 2088 | - continue; |
|
| 2089 | - } |
|
| 2090 | - if ($price->is_base_price()) { |
|
| 2091 | - $template_args['default_base_price_amount'] = $price->get_pretty( |
|
| 2092 | - 'PRC_amount', |
|
| 2093 | - 'localized_float' |
|
| 2094 | - ); |
|
| 2095 | - $template_args['default_base_price_name'] = $price->get('PRC_name'); |
|
| 2096 | - $template_args['default_base_price_description'] = $price->get('PRC_desc'); |
|
| 2097 | - $price_row++; |
|
| 2098 | - continue; |
|
| 2099 | - } |
|
| 2100 | - $show_trash = !((count($default_prices) > 1 && $price_row === 1) || count($default_prices) === 1); |
|
| 2101 | - $show_create = !(count($default_prices) > 1 && count($default_prices) !== $price_row); |
|
| 2102 | - $template_args['default_price_rows'] .= $this->_get_ticket_price_row( |
|
| 2103 | - 'TICKETNUM', |
|
| 2104 | - $price_row, |
|
| 2105 | - $price, |
|
| 2106 | - true, |
|
| 2107 | - null, |
|
| 2108 | - $show_trash, |
|
| 2109 | - $show_create |
|
| 2110 | - ); |
|
| 2111 | - $price_row++; |
|
| 2112 | - } |
|
| 2113 | - $template_args = apply_filters( |
|
| 2114 | - 'FHEE__espresso_events_Pricing_Hooks___get_ticket_js_structure__template_args', |
|
| 2115 | - $template_args, |
|
| 2116 | - $all_datetimes, |
|
| 2117 | - $all_tickets, |
|
| 2118 | - $this->_is_creating_event |
|
| 2119 | - ); |
|
| 2120 | - return EEH_Template::display_template( |
|
| 2121 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php', |
|
| 2122 | - $template_args, |
|
| 2123 | - true |
|
| 2124 | - ); |
|
| 2125 | - } |
|
| 18 | + /** |
|
| 19 | + * This property is just used to hold the status of whether an event is currently being |
|
| 20 | + * created (true) or edited (false) |
|
| 21 | + * |
|
| 22 | + * @access protected |
|
| 23 | + * @var bool |
|
| 24 | + */ |
|
| 25 | + protected $_is_creating_event; |
|
| 26 | + |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * Used to contain the format strings for date and time that will be used for php date and |
|
| 30 | + * time. |
|
| 31 | + * Is set in the _set_hooks_properties() method. |
|
| 32 | + * |
|
| 33 | + * @var array |
|
| 34 | + */ |
|
| 35 | + protected $_date_format_strings; |
|
| 36 | + |
|
| 37 | + |
|
| 38 | + /** |
|
| 39 | + * @var string $_date_time_format |
|
| 40 | + */ |
|
| 41 | + protected $_date_time_format; |
|
| 42 | + |
|
| 43 | + |
|
| 44 | + |
|
| 45 | + /** |
|
| 46 | + * |
|
| 47 | + */ |
|
| 48 | + protected function _set_hooks_properties() |
|
| 49 | + { |
|
| 50 | + $this->_name = 'pricing'; |
|
| 51 | + //capability check |
|
| 52 | + if (! EE_Registry::instance()->CAP->current_user_can( |
|
| 53 | + 'ee_read_default_prices', |
|
| 54 | + 'advanced_ticket_datetime_metabox' |
|
| 55 | + )) { |
|
| 56 | + return; |
|
| 57 | + } |
|
| 58 | + $this->_setup_metaboxes(); |
|
| 59 | + $this->_set_date_time_formats(); |
|
| 60 | + $this->_validate_format_strings(); |
|
| 61 | + $this->_set_scripts_styles(); |
|
| 62 | + // commented out temporarily until logic is implemented in callback |
|
| 63 | + // add_action( |
|
| 64 | + // 'AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_Extend_Events_Admin_Page', |
|
| 65 | + // array($this, 'autosave_handling') |
|
| 66 | + // ); |
|
| 67 | + add_filter( |
|
| 68 | + 'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks', |
|
| 69 | + array($this, 'caf_updates') |
|
| 70 | + ); |
|
| 71 | + } |
|
| 72 | + |
|
| 73 | + |
|
| 74 | + |
|
| 75 | + /** |
|
| 76 | + * @return void |
|
| 77 | + */ |
|
| 78 | + protected function _setup_metaboxes() |
|
| 79 | + { |
|
| 80 | + //if we were going to add our own metaboxes we'd use the below. |
|
| 81 | + $this->_metaboxes = array( |
|
| 82 | + 0 => array( |
|
| 83 | + 'page_route' => array('edit', 'create_new'), |
|
| 84 | + 'func' => 'pricing_metabox', |
|
| 85 | + 'label' => esc_html__('Event Tickets & Datetimes', 'event_espresso'), |
|
| 86 | + 'priority' => 'high', |
|
| 87 | + 'context' => 'normal', |
|
| 88 | + ), |
|
| 89 | + ); |
|
| 90 | + $this->_remove_metaboxes = array( |
|
| 91 | + 0 => array( |
|
| 92 | + 'page_route' => array('edit', 'create_new'), |
|
| 93 | + 'id' => 'espresso_event_editor_tickets', |
|
| 94 | + 'context' => 'normal', |
|
| 95 | + ), |
|
| 96 | + ); |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * @return void |
|
| 103 | + */ |
|
| 104 | + protected function _set_date_time_formats() |
|
| 105 | + { |
|
| 106 | + /** |
|
| 107 | + * Format strings for date and time. Defaults are existing behaviour from 4.1. |
|
| 108 | + * Note, that if you return null as the value for 'date', and 'time' in the array, then |
|
| 109 | + * EE will automatically use the set wp_options, 'date_format', and 'time_format'. |
|
| 110 | + * |
|
| 111 | + * @since 4.6.7 |
|
| 112 | + * @var array Expected an array returned with 'date' and 'time' keys. |
|
| 113 | + */ |
|
| 114 | + $this->_date_format_strings = apply_filters( |
|
| 115 | + 'FHEE__espresso_events_Pricing_Hooks___set_hooks_properties__date_format_strings', |
|
| 116 | + array( |
|
| 117 | + 'date' => 'Y-m-d', |
|
| 118 | + 'time' => 'h:i a', |
|
| 119 | + ) |
|
| 120 | + ); |
|
| 121 | + //validate |
|
| 122 | + $this->_date_format_strings['date'] = isset($this->_date_format_strings['date']) |
|
| 123 | + ? $this->_date_format_strings['date'] |
|
| 124 | + : null; |
|
| 125 | + $this->_date_format_strings['time'] = isset($this->_date_format_strings['time']) |
|
| 126 | + ? $this->_date_format_strings['time'] |
|
| 127 | + : null; |
|
| 128 | + $this->_date_time_format = $this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']; |
|
| 129 | + } |
|
| 130 | + |
|
| 131 | + |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * @return void |
|
| 135 | + */ |
|
| 136 | + protected function _validate_format_strings() |
|
| 137 | + { |
|
| 138 | + //validate format strings |
|
| 139 | + $format_validation = EEH_DTT_Helper::validate_format_string( |
|
| 140 | + $this->_date_time_format |
|
| 141 | + ); |
|
| 142 | + if (is_array($format_validation)) { |
|
| 143 | + $msg = '<p>'; |
|
| 144 | + $msg .= sprintf( |
|
| 145 | + esc_html__( |
|
| 146 | + 'The format "%s" was likely added via a filter and is invalid for the following reasons:', |
|
| 147 | + 'event_espresso' |
|
| 148 | + ), |
|
| 149 | + $this->_date_time_format |
|
| 150 | + ); |
|
| 151 | + $msg .= '</p><ul>'; |
|
| 152 | + foreach ($format_validation as $error) { |
|
| 153 | + $msg .= '<li>' . $error . '</li>'; |
|
| 154 | + } |
|
| 155 | + $msg .= '</ul><p>'; |
|
| 156 | + $msg .= sprintf( |
|
| 157 | + esc_html__( |
|
| 158 | + '%sPlease note that your date and time formats have been reset to "Y-m-d" and "h:i a" respectively.%s', |
|
| 159 | + 'event_espresso' |
|
| 160 | + ), |
|
| 161 | + '<span style="color:#D54E21;">', |
|
| 162 | + '</span>' |
|
| 163 | + ); |
|
| 164 | + $msg .= '</p>'; |
|
| 165 | + EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 166 | + $this->_date_format_strings = array( |
|
| 167 | + 'date' => 'Y-m-d', |
|
| 168 | + 'time' => 'h:i a', |
|
| 169 | + ); |
|
| 170 | + } |
|
| 171 | + } |
|
| 172 | + |
|
| 173 | + |
|
| 174 | + |
|
| 175 | + /** |
|
| 176 | + * @return void |
|
| 177 | + */ |
|
| 178 | + protected function _set_scripts_styles() |
|
| 179 | + { |
|
| 180 | + $this->_scripts_styles = array( |
|
| 181 | + 'registers' => array( |
|
| 182 | + 'ee-tickets-datetimes-css' => array( |
|
| 183 | + 'url' => PRICING_ASSETS_URL . 'event-tickets-datetimes.css', |
|
| 184 | + 'type' => 'css', |
|
| 185 | + ), |
|
| 186 | + 'ee-dtt-ticket-metabox' => array( |
|
| 187 | + 'url' => PRICING_ASSETS_URL . 'ee-datetime-ticket-metabox.js', |
|
| 188 | + 'depends' => array('ee-datepicker', 'ee-dialog', 'underscore'), |
|
| 189 | + ), |
|
| 190 | + ), |
|
| 191 | + 'deregisters' => array( |
|
| 192 | + 'event-editor-css' => array('type' => 'css'), |
|
| 193 | + 'event-datetime-metabox' => array('type' => 'js'), |
|
| 194 | + ), |
|
| 195 | + 'enqueues' => array( |
|
| 196 | + 'ee-tickets-datetimes-css' => array('edit', 'create_new'), |
|
| 197 | + 'ee-dtt-ticket-metabox' => array('edit', 'create_new'), |
|
| 198 | + ), |
|
| 199 | + 'localize' => array( |
|
| 200 | + 'ee-dtt-ticket-metabox' => array( |
|
| 201 | + 'DTT_TRASH_BLOCK' => array( |
|
| 202 | + 'main_warning' => esc_html__( |
|
| 203 | + 'The Datetime you are attempting to trash is the only datetime selected for the following ticket(s):', |
|
| 204 | + 'event_espresso' |
|
| 205 | + ), |
|
| 206 | + 'after_warning' => esc_html__( |
|
| 207 | + 'In order to trash this datetime you must first make sure the above ticket(s) are assigned to other datetimes.', |
|
| 208 | + 'event_espresso' |
|
| 209 | + ), |
|
| 210 | + 'cancel_button' => '<button class="button-secondary ee-modal-cancel">' |
|
| 211 | + . esc_html__('Cancel', 'event_espresso') . '</button>', |
|
| 212 | + 'close_button' => '<button class="button-secondary ee-modal-cancel">' |
|
| 213 | + . esc_html__('Close', 'event_espresso') . '</button>', |
|
| 214 | + 'single_warning_from_tkt' => esc_html__( |
|
| 215 | + 'The Datetime you are attempting to unassign from this ticket is the only remaining datetime for this ticket. Tickets must always have at least one datetime assigned to them.', |
|
| 216 | + 'event_espresso' |
|
| 217 | + ), |
|
| 218 | + 'single_warning_from_dtt' => esc_html__( |
|
| 219 | + 'The ticket you are attempting to unassign from this datetime cannot be unassigned because the datetime is the only remaining datetime for the ticket. Tickets must always have at least one datetime assigned to them.', |
|
| 220 | + 'event_espresso' |
|
| 221 | + ), |
|
| 222 | + 'dismiss_button' => '<button class="button-secondary ee-modal-cancel">' |
|
| 223 | + . esc_html__('Dismiss', 'event_espresso') . '</button>', |
|
| 224 | + ), |
|
| 225 | + 'DTT_ERROR_MSG' => array( |
|
| 226 | + 'no_ticket_name' => esc_html__('General Admission', 'event_espresso'), |
|
| 227 | + 'dismiss_button' => '<div class="save-cancel-button-container"><button class="button-secondary ee-modal-cancel">' |
|
| 228 | + . esc_html__('Dismiss', 'event_espresso') . '</button></div>', |
|
| 229 | + ), |
|
| 230 | + 'DTT_OVERSELL_WARNING' => array( |
|
| 231 | + 'datetime_ticket' => esc_html__( |
|
| 232 | + 'You cannot add this ticket to this datetime because it has a sold amount that is greater than the amount of spots remaining for this datetime.', |
|
| 233 | + 'event_espresso' |
|
| 234 | + ), |
|
| 235 | + 'ticket_datetime' => esc_html__( |
|
| 236 | + 'You cannot add this datetime to this ticket because the ticket has a sold amount that is greater than the amount of spots remaining on the datetime.', |
|
| 237 | + 'event_espresso' |
|
| 238 | + ), |
|
| 239 | + ), |
|
| 240 | + 'DTT_CONVERTED_FORMATS' => EEH_DTT_Helper::convert_php_to_js_and_moment_date_formats( |
|
| 241 | + $this->_date_format_strings['date'], |
|
| 242 | + $this->_date_format_strings['time'] |
|
| 243 | + ), |
|
| 244 | + 'DTT_START_OF_WEEK' => array('dayValue' => (int)get_option('start_of_week')), |
|
| 245 | + ), |
|
| 246 | + ), |
|
| 247 | + ); |
|
| 248 | + } |
|
| 249 | + |
|
| 250 | + |
|
| 251 | + |
|
| 252 | + /** |
|
| 253 | + * @param array $update_callbacks |
|
| 254 | + * @return array |
|
| 255 | + */ |
|
| 256 | + public function caf_updates(array $update_callbacks) |
|
| 257 | + { |
|
| 258 | + foreach ($update_callbacks as $key => $callback) { |
|
| 259 | + if ($callback[1] === '_default_tickets_update') { |
|
| 260 | + unset($update_callbacks[$key]); |
|
| 261 | + } |
|
| 262 | + } |
|
| 263 | + $update_callbacks[] = array($this, 'datetime_and_tickets_caf_update'); |
|
| 264 | + return $update_callbacks; |
|
| 265 | + } |
|
| 266 | + |
|
| 267 | + |
|
| 268 | + /** |
|
| 269 | + * Handles saving everything related to Tickets (datetimes, tickets, prices) |
|
| 270 | + * |
|
| 271 | + * @param EE_Event $event The Event object we're attaching data to |
|
| 272 | + * @param array $data The request data from the form |
|
| 273 | + * @throws EE_Error |
|
| 274 | + * @throws InvalidArgumentException |
|
| 275 | + */ |
|
| 276 | + public function datetime_and_tickets_caf_update($event, $data) |
|
| 277 | + { |
|
| 278 | + //first we need to start with datetimes cause they are the "root" items attached to events. |
|
| 279 | + $saved_datetimes = $this->_update_datetimes($event, $data); |
|
| 280 | + //next tackle the tickets (and prices?) |
|
| 281 | + $this->_update_tickets($event, $saved_datetimes, $data); |
|
| 282 | + } |
|
| 283 | + |
|
| 284 | + |
|
| 285 | + /** |
|
| 286 | + * update event_datetimes |
|
| 287 | + * |
|
| 288 | + * @param EE_Event $event Event being updated |
|
| 289 | + * @param array $data the request data from the form |
|
| 290 | + * @return EE_Datetime[] |
|
| 291 | + * @throws InvalidArgumentException |
|
| 292 | + * @throws EE_Error |
|
| 293 | + */ |
|
| 294 | + protected function _update_datetimes($event, $data) |
|
| 295 | + { |
|
| 296 | + $timezone = isset($data['timezone_string']) ? $data['timezone_string'] : null; |
|
| 297 | + $saved_dtt_ids = array(); |
|
| 298 | + $saved_dtt_objs = array(); |
|
| 299 | + if (empty($data['edit_event_datetimes']) || !is_array($data['edit_event_datetimes'])) { |
|
| 300 | + throw new InvalidArgumentException( |
|
| 301 | + esc_html__( |
|
| 302 | + 'The "edit_event_datetimes" array is invalid therefore the event can not be updated.', |
|
| 303 | + 'event_espresso' |
|
| 304 | + ) |
|
| 305 | + ); |
|
| 306 | + } |
|
| 307 | + foreach ($data['edit_event_datetimes'] as $row => $datetime_data) { |
|
| 308 | + //trim all values to ensure any excess whitespace is removed. |
|
| 309 | + $datetime_data = array_map( |
|
| 310 | + function ($datetime_data) { |
|
| 311 | + return is_array($datetime_data) ? $datetime_data : trim($datetime_data); |
|
| 312 | + }, |
|
| 313 | + $datetime_data |
|
| 314 | + ); |
|
| 315 | + $datetime_data['DTT_EVT_end'] = isset($datetime_data['DTT_EVT_end']) |
|
| 316 | + && ! empty($datetime_data['DTT_EVT_end']) |
|
| 317 | + ? $datetime_data['DTT_EVT_end'] |
|
| 318 | + : $datetime_data['DTT_EVT_start']; |
|
| 319 | + $datetime_values = array( |
|
| 320 | + 'DTT_ID' => ! empty($datetime_data['DTT_ID']) |
|
| 321 | + ? $datetime_data['DTT_ID'] |
|
| 322 | + : null, |
|
| 323 | + 'DTT_name' => ! empty($datetime_data['DTT_name']) |
|
| 324 | + ? $datetime_data['DTT_name'] |
|
| 325 | + : '', |
|
| 326 | + 'DTT_description' => ! empty($datetime_data['DTT_description']) |
|
| 327 | + ? $datetime_data['DTT_description'] |
|
| 328 | + : '', |
|
| 329 | + 'DTT_EVT_start' => $datetime_data['DTT_EVT_start'], |
|
| 330 | + 'DTT_EVT_end' => $datetime_data['DTT_EVT_end'], |
|
| 331 | + 'DTT_reg_limit' => empty($datetime_data['DTT_reg_limit']) |
|
| 332 | + ? EE_INF |
|
| 333 | + : $datetime_data['DTT_reg_limit'], |
|
| 334 | + 'DTT_order' => ! isset($datetime_data['DTT_order']) |
|
| 335 | + ? $row |
|
| 336 | + : $datetime_data['DTT_order'], |
|
| 337 | + ); |
|
| 338 | + // if we have an id then let's get existing object first and then set the new values. |
|
| 339 | + // Otherwise we instantiate a new object for save. |
|
| 340 | + if (! empty($datetime_data['DTT_ID'])) { |
|
| 341 | + $datetime = EE_Registry::instance() |
|
| 342 | + ->load_model('Datetime', array($timezone)) |
|
| 343 | + ->get_one_by_ID($datetime_data['DTT_ID']); |
|
| 344 | + //set date and time format according to what is set in this class. |
|
| 345 | + $datetime->set_date_format($this->_date_format_strings['date']); |
|
| 346 | + $datetime->set_time_format($this->_date_format_strings['time']); |
|
| 347 | + foreach ($datetime_values as $field => $value) { |
|
| 348 | + $datetime->set($field, $value); |
|
| 349 | + } |
|
| 350 | + // make sure the $dtt_id here is saved just in case |
|
| 351 | + // after the add_relation_to() the autosave replaces it. |
|
| 352 | + // We need to do this so we dont' TRASH the parent DTT. |
|
| 353 | + // (save the ID for both key and value to avoid duplications) |
|
| 354 | + $saved_dtt_ids[$datetime->ID()] = $datetime->ID(); |
|
| 355 | + } else { |
|
| 356 | + $datetime = EE_Registry::instance()->load_class( |
|
| 357 | + 'Datetime', |
|
| 358 | + array( |
|
| 359 | + $datetime_values, |
|
| 360 | + $timezone, |
|
| 361 | + array($this->_date_format_strings['date'], $this->_date_format_strings['time']), |
|
| 362 | + ), |
|
| 363 | + false, |
|
| 364 | + false |
|
| 365 | + ); |
|
| 366 | + foreach ($datetime_values as $field => $value) { |
|
| 367 | + $datetime->set($field, $value); |
|
| 368 | + } |
|
| 369 | + } |
|
| 370 | + $datetime->save(); |
|
| 371 | + $datetime = $event->_add_relation_to($datetime, 'Datetime'); |
|
| 372 | + // before going any further make sure our dates are setup correctly |
|
| 373 | + // so that the end date is always equal or greater than the start date. |
|
| 374 | + if ($datetime->get_raw('DTT_EVT_start') > $datetime->get_raw('DTT_EVT_end')) { |
|
| 375 | + $datetime->set('DTT_EVT_end', $datetime->get('DTT_EVT_start')); |
|
| 376 | + $datetime = EEH_DTT_Helper::date_time_add($datetime, 'DTT_EVT_end', 'days'); |
|
| 377 | + $datetime->save(); |
|
| 378 | + } |
|
| 379 | + // now we have to make sure we add the new DTT_ID to the $saved_dtt_ids array |
|
| 380 | + // because it is possible there was a new one created for the autosave. |
|
| 381 | + // (save the ID for both key and value to avoid duplications) |
|
| 382 | + $DTT_ID = $datetime->ID(); |
|
| 383 | + $saved_dtt_ids[$DTT_ID] = $DTT_ID; |
|
| 384 | + $saved_dtt_objs[$row] = $datetime; |
|
| 385 | + //todo if ANY of these updates fail then we want the appropriate global error message. |
|
| 386 | + } |
|
| 387 | + $event->save(); |
|
| 388 | + // now we need to REMOVE any datetimes that got deleted. |
|
| 389 | + // Keep in mind that this process will only kick in for datetimes that don't have any DTT_sold on them. |
|
| 390 | + // So its safe to permanently delete at this point. |
|
| 391 | + $old_datetimes = explode(',', $data['datetime_IDs']); |
|
| 392 | + $old_datetimes = $old_datetimes[0] === '' ? array() : $old_datetimes; |
|
| 393 | + if (is_array($old_datetimes)) { |
|
| 394 | + $datetimes_to_delete = array_diff($old_datetimes, $saved_dtt_ids); |
|
| 395 | + foreach ($datetimes_to_delete as $id) { |
|
| 396 | + $id = absint($id); |
|
| 397 | + if (empty($id)) { |
|
| 398 | + continue; |
|
| 399 | + } |
|
| 400 | + $dtt_to_remove = EE_Registry::instance()->load_model('Datetime')->get_one_by_ID($id); |
|
| 401 | + //remove tkt relationships. |
|
| 402 | + $related_tickets = $dtt_to_remove->get_many_related('Ticket'); |
|
| 403 | + foreach ($related_tickets as $tkt) { |
|
| 404 | + $dtt_to_remove->_remove_relation_to($tkt, 'Ticket'); |
|
| 405 | + } |
|
| 406 | + $event->_remove_relation_to($id, 'Datetime'); |
|
| 407 | + $dtt_to_remove->refresh_cache_of_related_objects(); |
|
| 408 | + } |
|
| 409 | + } |
|
| 410 | + return $saved_dtt_objs; |
|
| 411 | + } |
|
| 412 | + |
|
| 413 | + |
|
| 414 | + /** |
|
| 415 | + * update tickets |
|
| 416 | + * |
|
| 417 | + * @param EE_Event $event Event object being updated |
|
| 418 | + * @param EE_Datetime[] $saved_datetimes an array of datetime ids being updated |
|
| 419 | + * @param array $data incoming request data |
|
| 420 | + * @return EE_Ticket[] |
|
| 421 | + * @throws InvalidArgumentException |
|
| 422 | + * @throws EE_Error |
|
| 423 | + */ |
|
| 424 | + protected function _update_tickets($event, $saved_datetimes, $data) |
|
| 425 | + { |
|
| 426 | + $new_tkt = null; |
|
| 427 | + $new_default = null; |
|
| 428 | + //stripslashes because WP filtered the $_POST ($data) array to add slashes |
|
| 429 | + $data = stripslashes_deep($data); |
|
| 430 | + $timezone = isset($data['timezone_string']) ? $data['timezone_string'] : null; |
|
| 431 | + $saved_tickets = $datetimes_on_existing = array(); |
|
| 432 | + $old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array(); |
|
| 433 | + if(empty($data['edit_tickets']) || ! is_array($data['edit_tickets'])){ |
|
| 434 | + throw new InvalidArgumentException( |
|
| 435 | + esc_html__( |
|
| 436 | + 'The "edit_tickets" array is invalid therefore the event can not be updated.', |
|
| 437 | + 'event_espresso' |
|
| 438 | + ) |
|
| 439 | + ); |
|
| 440 | + } |
|
| 441 | + foreach ($data['edit_tickets'] as $row => $tkt) { |
|
| 442 | + $update_prices = $create_new_TKT = false; |
|
| 443 | + // figure out what datetimes were added to the ticket |
|
| 444 | + // and what datetimes were removed from the ticket in the session. |
|
| 445 | + $starting_tkt_dtt_rows = explode(',', $data['starting_ticket_datetime_rows'][$row]); |
|
| 446 | + $tkt_dtt_rows = explode(',', $data['ticket_datetime_rows'][$row]); |
|
| 447 | + $datetimes_added = array_diff($tkt_dtt_rows, $starting_tkt_dtt_rows); |
|
| 448 | + $datetimes_removed = array_diff($starting_tkt_dtt_rows, $tkt_dtt_rows); |
|
| 449 | + // trim inputs to ensure any excess whitespace is removed. |
|
| 450 | + $tkt = array_map( |
|
| 451 | + function ($ticket_data) { |
|
| 452 | + return is_array($ticket_data) ? $ticket_data : trim($ticket_data); |
|
| 453 | + }, |
|
| 454 | + $tkt |
|
| 455 | + ); |
|
| 456 | + // note we are doing conversions to floats here instead of allowing EE_Money_Field to handle |
|
| 457 | + // because we're doing calculations prior to using the models. |
|
| 458 | + // note incoming ['TKT_price'] value is already in standard notation (via js). |
|
| 459 | + $ticket_price = isset($tkt['TKT_price']) |
|
| 460 | + ? round((float)$tkt['TKT_price'], 3) |
|
| 461 | + : 0; |
|
| 462 | + //note incoming base price needs converted from localized value. |
|
| 463 | + $base_price = isset($tkt['TKT_base_price']) |
|
| 464 | + ? EEH_Money::convert_to_float_from_localized_money($tkt['TKT_base_price']) |
|
| 465 | + : 0; |
|
| 466 | + //if ticket price == 0 and $base_price != 0 then ticket price == base_price |
|
| 467 | + $ticket_price = $ticket_price === 0 && $base_price !== 0 |
|
| 468 | + ? $base_price |
|
| 469 | + : $ticket_price; |
|
| 470 | + $base_price_id = isset($tkt['TKT_base_price_ID']) |
|
| 471 | + ? $tkt['TKT_base_price_ID'] |
|
| 472 | + : 0; |
|
| 473 | + $price_rows = is_array($data['edit_prices']) && isset($data['edit_prices'][$row]) |
|
| 474 | + ? $data['edit_prices'][$row] |
|
| 475 | + : array(); |
|
| 476 | + $now = null; |
|
| 477 | + if (empty($tkt['TKT_start_date'])) { |
|
| 478 | + //lets' use now in the set timezone. |
|
| 479 | + $now = new DateTime('now', new DateTimeZone($event->get_timezone())); |
|
| 480 | + $tkt['TKT_start_date'] = $now->format($this->_date_time_format); |
|
| 481 | + } |
|
| 482 | + if (empty($tkt['TKT_end_date'])) { |
|
| 483 | + /** |
|
| 484 | + * set the TKT_end_date to the first datetime attached to the ticket. |
|
| 485 | + */ |
|
| 486 | + $first_dtt = $saved_datetimes[reset($tkt_dtt_rows)]; |
|
| 487 | + $tkt['TKT_end_date'] = $first_dtt->start_date_and_time($this->_date_time_format); |
|
| 488 | + } |
|
| 489 | + $TKT_values = array( |
|
| 490 | + 'TKT_ID' => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null, |
|
| 491 | + 'TTM_ID' => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0, |
|
| 492 | + 'TKT_name' => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '', |
|
| 493 | + 'TKT_description' => ! empty($tkt['TKT_description']) |
|
| 494 | + && $tkt['TKT_description'] !== esc_html__( |
|
| 495 | + 'You can modify this description', |
|
| 496 | + 'event_espresso' |
|
| 497 | + ) |
|
| 498 | + ? $tkt['TKT_description'] |
|
| 499 | + : '', |
|
| 500 | + 'TKT_start_date' => $tkt['TKT_start_date'], |
|
| 501 | + 'TKT_end_date' => $tkt['TKT_end_date'], |
|
| 502 | + 'TKT_qty' => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === '' |
|
| 503 | + ? EE_INF |
|
| 504 | + : $tkt['TKT_qty'], |
|
| 505 | + 'TKT_uses' => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === '' |
|
| 506 | + ? EE_INF |
|
| 507 | + : $tkt['TKT_uses'], |
|
| 508 | + 'TKT_min' => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'], |
|
| 509 | + 'TKT_max' => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'], |
|
| 510 | + 'TKT_row' => $row, |
|
| 511 | + 'TKT_order' => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : 0, |
|
| 512 | + 'TKT_taxable' => ! empty($tkt['TKT_taxable']) ? 1 : 0, |
|
| 513 | + 'TKT_required' => ! empty($tkt['TKT_required']) ? 1 : 0, |
|
| 514 | + 'TKT_price' => $ticket_price, |
|
| 515 | + ); |
|
| 516 | + // if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly, |
|
| 517 | + // which means in turn that the prices will become new prices as well. |
|
| 518 | + if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) { |
|
| 519 | + $TKT_values['TKT_ID'] = 0; |
|
| 520 | + $TKT_values['TKT_is_default'] = 0; |
|
| 521 | + $update_prices = true; |
|
| 522 | + } |
|
| 523 | + // if we have a TKT_ID then we need to get that existing TKT_obj and update it |
|
| 524 | + // we actually do our saves ahead of doing any add_relations to |
|
| 525 | + // because its entirely possible that this ticket wasn't removed or added to any datetime in the session |
|
| 526 | + // but DID have it's items modified. |
|
| 527 | + // keep in mind that if the TKT has been sold (and we have changed pricing information), |
|
| 528 | + // then we won't be updating the tkt but instead a new tkt will be created and the old one archived. |
|
| 529 | + if (absint($TKT_values['TKT_ID'])) { |
|
| 530 | + $ticket = EE_Registry::instance() |
|
| 531 | + ->load_model('Ticket', array($timezone)) |
|
| 532 | + ->get_one_by_ID($tkt['TKT_ID']); |
|
| 533 | + if ($ticket instanceof EE_Ticket) { |
|
| 534 | + $ticket = $this->_update_ticket_datetimes( |
|
| 535 | + $ticket, |
|
| 536 | + $saved_datetimes, |
|
| 537 | + $datetimes_added, |
|
| 538 | + $datetimes_removed |
|
| 539 | + ); |
|
| 540 | + // are there any registrations using this ticket ? |
|
| 541 | + $tickets_sold = $ticket->count_related( |
|
| 542 | + 'Registration', |
|
| 543 | + array( |
|
| 544 | + array( |
|
| 545 | + 'STS_ID' => array('NOT IN', array(EEM_Registration::status_id_incomplete)), |
|
| 546 | + ), |
|
| 547 | + ) |
|
| 548 | + ); |
|
| 549 | + //set ticket formats |
|
| 550 | + $ticket->set_date_format($this->_date_format_strings['date']); |
|
| 551 | + $ticket->set_time_format($this->_date_format_strings['time']); |
|
| 552 | + // let's just check the total price for the existing ticket |
|
| 553 | + // and determine if it matches the new total price. |
|
| 554 | + // if they are different then we create a new ticket (if tickets sold) |
|
| 555 | + // if they aren't different then we go ahead and modify existing ticket. |
|
| 556 | + $create_new_TKT = $tickets_sold > 0 && $ticket_price !== $ticket->price() && ! $ticket->deleted(); |
|
| 557 | + //set new values |
|
| 558 | + foreach ($TKT_values as $field => $value) { |
|
| 559 | + if ($field === 'TKT_qty') { |
|
| 560 | + $ticket->set_qty($value); |
|
| 561 | + } else { |
|
| 562 | + $ticket->set($field, $value); |
|
| 563 | + } |
|
| 564 | + } |
|
| 565 | + // if $create_new_TKT is false then we can safely update the existing ticket. |
|
| 566 | + // Otherwise we have to create a new ticket. |
|
| 567 | + if ($create_new_TKT) { |
|
| 568 | + $new_tkt = $this->_duplicate_ticket($ticket, $price_rows, $ticket_price, $base_price, |
|
| 569 | + $base_price_id); |
|
| 570 | + } |
|
| 571 | + } |
|
| 572 | + } else { |
|
| 573 | + // no TKT_id so a new TKT |
|
| 574 | + $ticket = EE_Ticket::new_instance( |
|
| 575 | + $TKT_values, |
|
| 576 | + $timezone, |
|
| 577 | + array($this->_date_format_strings['date'], $this->_date_format_strings['time']) |
|
| 578 | + ); |
|
| 579 | + if ($ticket instanceof EE_Ticket) { |
|
| 580 | + // make sure ticket has an ID of setting relations won't work |
|
| 581 | + $ticket->save(); |
|
| 582 | + $ticket = $this->_update_ticket_datetimes( |
|
| 583 | + $ticket, |
|
| 584 | + $saved_datetimes, |
|
| 585 | + $datetimes_added, |
|
| 586 | + $datetimes_removed |
|
| 587 | + ); |
|
| 588 | + $update_prices = true; |
|
| 589 | + } |
|
| 590 | + } |
|
| 591 | + //make sure any current values have been saved. |
|
| 592 | + //$ticket->save(); |
|
| 593 | + // before going any further make sure our dates are setup correctly |
|
| 594 | + // so that the end date is always equal or greater than the start date. |
|
| 595 | + if ($ticket->get_raw('TKT_start_date') > $ticket->get_raw('TKT_end_date')) { |
|
| 596 | + $ticket->set('TKT_end_date', $ticket->get('TKT_start_date')); |
|
| 597 | + $ticket = EEH_DTT_Helper::date_time_add($ticket, 'TKT_end_date', 'days'); |
|
| 598 | + } |
|
| 599 | + //let's make sure the base price is handled |
|
| 600 | + $ticket = ! $create_new_TKT ? $this->_add_prices_to_ticket(array(), $ticket, $update_prices, $base_price, |
|
| 601 | + $base_price_id) : $ticket; |
|
| 602 | + //add/update price_modifiers |
|
| 603 | + $ticket = ! $create_new_TKT ? $this->_add_prices_to_ticket($price_rows, $ticket, $update_prices) : $ticket; |
|
| 604 | + //need to make sue that the TKT_price is accurate after saving the prices. |
|
| 605 | + $ticket->ensure_TKT_Price_correct(); |
|
| 606 | + //handle CREATING a default tkt from the incoming tkt but ONLY if this isn't an autosave. |
|
| 607 | + if (! defined('DOING_AUTOSAVE') && ! empty($tkt['TKT_is_default_selector'])) { |
|
| 608 | + $update_prices = true; |
|
| 609 | + $new_default = clone $ticket; |
|
| 610 | + $new_default->set('TKT_ID', 0); |
|
| 611 | + $new_default->set('TKT_is_default', 1); |
|
| 612 | + $new_default->set('TKT_row', 1); |
|
| 613 | + $new_default->set('TKT_price', $ticket_price); |
|
| 614 | + // remove any dtt relations cause we DON'T want dtt relations attached |
|
| 615 | + // (note this is just removing the cached relations in the object) |
|
| 616 | + $new_default->_remove_relations('Datetime'); |
|
| 617 | + //todo we need to add the current attached prices as new prices to the new default ticket. |
|
| 618 | + $new_default = $this->_add_prices_to_ticket($price_rows, $new_default, $update_prices); |
|
| 619 | + //don't forget the base price! |
|
| 620 | + $new_default = $this->_add_prices_to_ticket( |
|
| 621 | + array(), |
|
| 622 | + $new_default, |
|
| 623 | + $update_prices, |
|
| 624 | + $base_price, |
|
| 625 | + $base_price_id |
|
| 626 | + ); |
|
| 627 | + $new_default->save(); |
|
| 628 | + do_action( |
|
| 629 | + 'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_default_ticket', |
|
| 630 | + $new_default, |
|
| 631 | + $row, |
|
| 632 | + $ticket, |
|
| 633 | + $data |
|
| 634 | + ); |
|
| 635 | + } |
|
| 636 | + // DO ALL dtt relationships for both current tickets and any archived tickets |
|
| 637 | + // for the given dtt that are related to the current ticket. |
|
| 638 | + // TODO... not sure exactly how we're going to do this considering we don't know |
|
| 639 | + // what current ticket the archived tickets are related to |
|
| 640 | + // (and TKT_parent is used for autosaves so that's not a field we can reliably use). |
|
| 641 | + //let's assign any tickets that have been setup to the saved_tickets tracker |
|
| 642 | + //save existing TKT |
|
| 643 | + $ticket->save(); |
|
| 644 | + if ($create_new_TKT && $new_tkt instanceof EE_Ticket) { |
|
| 645 | + //save new TKT |
|
| 646 | + $new_tkt->save(); |
|
| 647 | + //add new ticket to array |
|
| 648 | + $saved_tickets[$new_tkt->ID()] = $new_tkt; |
|
| 649 | + do_action( |
|
| 650 | + 'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_ticket', |
|
| 651 | + $new_tkt, |
|
| 652 | + $row, |
|
| 653 | + $tkt, |
|
| 654 | + $data |
|
| 655 | + ); |
|
| 656 | + } else { |
|
| 657 | + //add tkt to saved tkts |
|
| 658 | + $saved_tickets[$ticket->ID()] = $ticket; |
|
| 659 | + do_action( |
|
| 660 | + 'AHEE__espresso_events_Pricing_Hooks___update_tkts_update_ticket', |
|
| 661 | + $ticket, |
|
| 662 | + $row, |
|
| 663 | + $tkt, |
|
| 664 | + $data |
|
| 665 | + ); |
|
| 666 | + } |
|
| 667 | + } |
|
| 668 | + // now we need to handle tickets actually "deleted permanently". |
|
| 669 | + // There are cases where we'd want this to happen |
|
| 670 | + // (i.e. autosaves are happening and then in between autosaves the user trashes a ticket). |
|
| 671 | + // Or a draft event was saved and in the process of editing a ticket is trashed. |
|
| 672 | + // No sense in keeping all the related data in the db! |
|
| 673 | + $old_tickets = isset($old_tickets[0]) && $old_tickets[0] === '' ? array() : $old_tickets; |
|
| 674 | + $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets)); |
|
| 675 | + foreach ($tickets_removed as $id) { |
|
| 676 | + $id = absint($id); |
|
| 677 | + //get the ticket for this id |
|
| 678 | + $tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id); |
|
| 679 | + //if this tkt is a default tkt we leave it alone cause it won't be attached to the datetime |
|
| 680 | + if ($tkt_to_remove->get('TKT_is_default')) { |
|
| 681 | + continue; |
|
| 682 | + } |
|
| 683 | + // if this tkt has any registrations attached so then we just ARCHIVE |
|
| 684 | + // because we don't actually permanently delete these tickets. |
|
| 685 | + if ($tkt_to_remove->count_related('Registration') > 0) { |
|
| 686 | + $tkt_to_remove->delete(); |
|
| 687 | + continue; |
|
| 688 | + } |
|
| 689 | + // need to get all the related datetimes on this ticket and remove from every single one of them |
|
| 690 | + // (remember this process can ONLY kick off if there are NO tkts_sold) |
|
| 691 | + $datetimes = $tkt_to_remove->get_many_related('Datetime'); |
|
| 692 | + foreach ($datetimes as $datetime) { |
|
| 693 | + $tkt_to_remove->_remove_relation_to($datetime, 'Datetime'); |
|
| 694 | + } |
|
| 695 | + // need to do the same for prices (except these prices can also be deleted because again, |
|
| 696 | + // tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived)) |
|
| 697 | + $tkt_to_remove->delete_related_permanently('Price'); |
|
| 698 | + do_action('AHEE__espresso_events_Pricing_Hooks___update_tkts_delete_ticket', $tkt_to_remove); |
|
| 699 | + // finally let's delete this ticket |
|
| 700 | + // (which should not be blocked at this point b/c we've removed all our relationships) |
|
| 701 | + $tkt_to_remove->delete_permanently(); |
|
| 702 | + } |
|
| 703 | + return $saved_tickets; |
|
| 704 | + } |
|
| 705 | + |
|
| 706 | + |
|
| 707 | + |
|
| 708 | + /** |
|
| 709 | + * @access protected |
|
| 710 | + * @param \EE_Ticket $ticket |
|
| 711 | + * @param \EE_Datetime[] $saved_datetimes |
|
| 712 | + * @param \EE_Datetime[] $added_datetimes |
|
| 713 | + * @param \EE_Datetime[] $removed_datetimes |
|
| 714 | + * @return \EE_Ticket |
|
| 715 | + * @throws \EE_Error |
|
| 716 | + */ |
|
| 717 | + protected function _update_ticket_datetimes( |
|
| 718 | + EE_Ticket $ticket, |
|
| 719 | + $saved_datetimes = array(), |
|
| 720 | + $added_datetimes = array(), |
|
| 721 | + $removed_datetimes = array() |
|
| 722 | + ) { |
|
| 723 | + // to start we have to add the ticket to all the datetimes its supposed to be with, |
|
| 724 | + // and removing the ticket from datetimes it got removed from. |
|
| 725 | + // first let's add datetimes |
|
| 726 | + if (! empty($added_datetimes) && is_array($added_datetimes)) { |
|
| 727 | + foreach ($added_datetimes as $row_id) { |
|
| 728 | + $row_id = (int)$row_id; |
|
| 729 | + if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) { |
|
| 730 | + $ticket->_add_relation_to($saved_datetimes[$row_id], 'Datetime'); |
|
| 731 | + // Is this an existing ticket (has an ID) and does it have any sold? |
|
| 732 | + // If so, then we need to add that to the DTT sold because this DTT is getting added. |
|
| 733 | + if ($ticket->ID() && $ticket->sold() > 0) { |
|
| 734 | + $saved_datetimes[$row_id]->increase_sold($ticket->sold()); |
|
| 735 | + $saved_datetimes[$row_id]->save(); |
|
| 736 | + } |
|
| 737 | + } |
|
| 738 | + } |
|
| 739 | + } |
|
| 740 | + // then remove datetimes |
|
| 741 | + if (! empty($removed_datetimes) && is_array($removed_datetimes)) { |
|
| 742 | + foreach ($removed_datetimes as $row_id) { |
|
| 743 | + $row_id = (int)$row_id; |
|
| 744 | + // its entirely possible that a datetime got deleted (instead of just removed from relationship. |
|
| 745 | + // So make sure we skip over this if the dtt isn't in the $saved_datetimes array) |
|
| 746 | + if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) { |
|
| 747 | + $ticket->_remove_relation_to($saved_datetimes[$row_id], 'Datetime'); |
|
| 748 | + // Is this an existing ticket (has an ID) and does it have any sold? |
|
| 749 | + // If so, then we need to remove it's sold from the DTT_sold. |
|
| 750 | + if ($ticket->ID() && $ticket->sold() > 0) { |
|
| 751 | + $saved_datetimes[$row_id]->decrease_sold($ticket->sold()); |
|
| 752 | + $saved_datetimes[$row_id]->save(); |
|
| 753 | + } |
|
| 754 | + } |
|
| 755 | + } |
|
| 756 | + } |
|
| 757 | + // cap ticket qty by datetime reg limits |
|
| 758 | + $ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit'))); |
|
| 759 | + return $ticket; |
|
| 760 | + } |
|
| 761 | + |
|
| 762 | + |
|
| 763 | + |
|
| 764 | + /** |
|
| 765 | + * @access protected |
|
| 766 | + * @param \EE_Ticket $ticket |
|
| 767 | + * @param array $price_rows |
|
| 768 | + * @param int $ticket_price |
|
| 769 | + * @param int $base_price |
|
| 770 | + * @param int $base_price_id |
|
| 771 | + * @return \EE_Ticket |
|
| 772 | + * @throws \EE_Error |
|
| 773 | + */ |
|
| 774 | + protected function _duplicate_ticket( |
|
| 775 | + EE_Ticket $ticket, |
|
| 776 | + $price_rows = array(), |
|
| 777 | + $ticket_price = 0, |
|
| 778 | + $base_price = 0, |
|
| 779 | + $base_price_id = 0 |
|
| 780 | + ) { |
|
| 781 | + // create new ticket that's a copy of the existing |
|
| 782 | + // except a new id of course (and not archived) |
|
| 783 | + // AND has the new TKT_price associated with it. |
|
| 784 | + $new_ticket = clone $ticket; |
|
| 785 | + $new_ticket->set('TKT_ID', 0); |
|
| 786 | + $new_ticket->set_deleted(0); |
|
| 787 | + $new_ticket->set_price($ticket_price); |
|
| 788 | + $new_ticket->set_sold(0); |
|
| 789 | + // let's get a new ID for this ticket |
|
| 790 | + $new_ticket->save(); |
|
| 791 | + // we also need to make sure this new ticket gets the same datetime attachments as the archived ticket |
|
| 792 | + $datetimes_on_existing = $ticket->datetimes(); |
|
| 793 | + $new_ticket = $this->_update_ticket_datetimes( |
|
| 794 | + $new_ticket, |
|
| 795 | + $datetimes_on_existing, |
|
| 796 | + array_keys($datetimes_on_existing) |
|
| 797 | + ); |
|
| 798 | + // $ticket will get archived later b/c we are NOT adding it to the saved_tickets array. |
|
| 799 | + // if existing $ticket has sold amount, then we need to adjust the qty for the new TKT to = the remaining |
|
| 800 | + // available. |
|
| 801 | + if ($ticket->sold() > 0) { |
|
| 802 | + $new_qty = $ticket->qty() - $ticket->sold(); |
|
| 803 | + $new_ticket->set_qty($new_qty); |
|
| 804 | + } |
|
| 805 | + //now we update the prices just for this ticket |
|
| 806 | + $new_ticket = $this->_add_prices_to_ticket($price_rows, $new_ticket, true); |
|
| 807 | + //and we update the base price |
|
| 808 | + $new_ticket = $this->_add_prices_to_ticket(array(), $new_ticket, true, $base_price, $base_price_id); |
|
| 809 | + return $new_ticket; |
|
| 810 | + } |
|
| 811 | + |
|
| 812 | + |
|
| 813 | + |
|
| 814 | + /** |
|
| 815 | + * This attaches a list of given prices to a ticket. |
|
| 816 | + * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change |
|
| 817 | + * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old |
|
| 818 | + * price info and prices are automatically "archived" via the ticket. |
|
| 819 | + * |
|
| 820 | + * @access private |
|
| 821 | + * @param array $prices Array of prices from the form. |
|
| 822 | + * @param EE_Ticket $ticket EE_Ticket object that prices are being attached to. |
|
| 823 | + * @param bool $new_prices Whether attach existing incoming prices or create new ones. |
|
| 824 | + * @param int|bool $base_price if FALSE then NOT doing a base price add. |
|
| 825 | + * @param int|bool $base_price_id if present then this is the base_price_id being updated. |
|
| 826 | + * @return EE_Ticket |
|
| 827 | + * @throws EE_Error |
|
| 828 | + */ |
|
| 829 | + protected function _add_prices_to_ticket( |
|
| 830 | + $prices = array(), |
|
| 831 | + EE_Ticket $ticket, |
|
| 832 | + $new_prices = false, |
|
| 833 | + $base_price = false, |
|
| 834 | + $base_price_id = false |
|
| 835 | + ) { |
|
| 836 | + // let's just get any current prices that may exist on the given ticket |
|
| 837 | + // so we can remove any prices that got trashed in this session. |
|
| 838 | + $current_prices_on_ticket = $base_price !== false |
|
| 839 | + ? $ticket->base_price(true) |
|
| 840 | + : $ticket->price_modifiers(); |
|
| 841 | + $updated_prices = array(); |
|
| 842 | + // if $base_price ! FALSE then updating a base price. |
|
| 843 | + if ($base_price !== false) { |
|
| 844 | + $prices[1] = array( |
|
| 845 | + 'PRC_ID' => $new_prices || $base_price_id === 1 ? null : $base_price_id, |
|
| 846 | + 'PRT_ID' => 1, |
|
| 847 | + 'PRC_amount' => $base_price, |
|
| 848 | + 'PRC_name' => $ticket->get('TKT_name'), |
|
| 849 | + 'PRC_desc' => $ticket->get('TKT_description'), |
|
| 850 | + ); |
|
| 851 | + } |
|
| 852 | + //possibly need to save tkt |
|
| 853 | + if (! $ticket->ID()) { |
|
| 854 | + $ticket->save(); |
|
| 855 | + } |
|
| 856 | + foreach ($prices as $row => $prc) { |
|
| 857 | + $prt_id = ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null; |
|
| 858 | + if (empty($prt_id)) { |
|
| 859 | + continue; |
|
| 860 | + } //prices MUST have a price type id. |
|
| 861 | + $PRC_values = array( |
|
| 862 | + 'PRC_ID' => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null, |
|
| 863 | + 'PRT_ID' => $prt_id, |
|
| 864 | + 'PRC_amount' => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0, |
|
| 865 | + 'PRC_name' => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '', |
|
| 866 | + 'PRC_desc' => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '', |
|
| 867 | + 'PRC_is_default' => false, |
|
| 868 | + //make sure we set PRC_is_default to false for all ticket saves from event_editor |
|
| 869 | + 'PRC_order' => $row, |
|
| 870 | + ); |
|
| 871 | + if ($new_prices || empty($PRC_values['PRC_ID'])) { |
|
| 872 | + $PRC_values['PRC_ID'] = 0; |
|
| 873 | + $price = EE_Registry::instance()->load_class( |
|
| 874 | + 'Price', |
|
| 875 | + array($PRC_values), |
|
| 876 | + false, |
|
| 877 | + false |
|
| 878 | + ); |
|
| 879 | + } else { |
|
| 880 | + $price = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']); |
|
| 881 | + //update this price with new values |
|
| 882 | + foreach ($PRC_values as $field => $value) { |
|
| 883 | + $price->set($field, $value); |
|
| 884 | + } |
|
| 885 | + } |
|
| 886 | + $price->save(); |
|
| 887 | + $updated_prices[$price->ID()] = $price; |
|
| 888 | + $ticket->_add_relation_to($price, 'Price'); |
|
| 889 | + } |
|
| 890 | + //now let's remove any prices that got removed from the ticket |
|
| 891 | + if (! empty ($current_prices_on_ticket)) { |
|
| 892 | + $current = array_keys($current_prices_on_ticket); |
|
| 893 | + $updated = array_keys($updated_prices); |
|
| 894 | + $prices_to_remove = array_diff($current, $updated); |
|
| 895 | + if (! empty($prices_to_remove)) { |
|
| 896 | + foreach ($prices_to_remove as $prc_id) { |
|
| 897 | + $p = $current_prices_on_ticket[$prc_id]; |
|
| 898 | + $ticket->_remove_relation_to($p, 'Price'); |
|
| 899 | + //delete permanently the price |
|
| 900 | + $p->delete_permanently(); |
|
| 901 | + } |
|
| 902 | + } |
|
| 903 | + } |
|
| 904 | + return $ticket; |
|
| 905 | + } |
|
| 906 | + |
|
| 907 | + |
|
| 908 | + |
|
| 909 | + /** |
|
| 910 | + * @param Events_Admin_Page $event_admin_obj |
|
| 911 | + * @return Events_Admin_Page |
|
| 912 | + */ |
|
| 913 | + public function autosave_handling( Events_Admin_Page $event_admin_obj) |
|
| 914 | + { |
|
| 915 | + return $event_admin_obj; |
|
| 916 | + //doing nothing for the moment. |
|
| 917 | + // todo when I get to this remember that I need to set the template args on the $event_admin_obj |
|
| 918 | + // (use the set_template_args() method) |
|
| 919 | + /** |
|
| 920 | + * need to remember to handle TICKET DEFAULT saves correctly: I've got two input fields in the dom: |
|
| 921 | + * 1. TKT_is_default_selector (visible) |
|
| 922 | + * 2. TKT_is_default (hidden) |
|
| 923 | + * I think we'll use the TKT_is_default for recording whether the ticket displayed IS a default ticket |
|
| 924 | + * (on new event creations). Whereas the TKT_is_default_selector is for the user to indicate they want |
|
| 925 | + * this ticket to be saved as a default. |
|
| 926 | + * The tricky part is, on an initial display on create or edit (or after manually updating), |
|
| 927 | + * the TKT_is_default_selector will always be unselected and the TKT_is_default will only be true |
|
| 928 | + * if this is a create. However, after an autosave, users will want some sort of indicator that |
|
| 929 | + * the TKT HAS been saved as a default.. |
|
| 930 | + * in other words we don't want to remove the check on TKT_is_default_selector. So here's what I'm thinking. |
|
| 931 | + * On Autosave: |
|
| 932 | + * 1. If TKT_is_default is true: we create a new TKT, send back the new id and add id to related elements, |
|
| 933 | + * then set the TKT_is_default to false. |
|
| 934 | + * 2. If TKT_is_default_selector is true: we create/edit existing ticket (following conditions above as well). |
|
| 935 | + * We do NOT create a new default ticket. The checkbox stays selected after autosave. |
|
| 936 | + * 3. only on MANUAL update do we check for the selection and if selected create the new default ticket. |
|
| 937 | + */ |
|
| 938 | + } |
|
| 939 | + |
|
| 940 | + |
|
| 941 | + |
|
| 942 | + /** |
|
| 943 | + * @throws DomainException |
|
| 944 | + * @throws EE_Error |
|
| 945 | + */ |
|
| 946 | + public function pricing_metabox() |
|
| 947 | + { |
|
| 948 | + $existing_datetime_ids = $existing_ticket_ids = $datetime_tickets = $ticket_datetimes = array(); |
|
| 949 | + $event = $this->_adminpage_obj->get_cpt_model_obj(); |
|
| 950 | + //set is_creating_event property. |
|
| 951 | + $EVT_ID = $event->ID(); |
|
| 952 | + $this->_is_creating_event = absint($EVT_ID) === 0; |
|
| 953 | + //default main template args |
|
| 954 | + $main_template_args = array( |
|
| 955 | + 'event_datetime_help_link' => EEH_Template::get_help_tab_link( |
|
| 956 | + 'event_editor_event_datetimes_help_tab', |
|
| 957 | + $this->_adminpage_obj->page_slug, |
|
| 958 | + $this->_adminpage_obj->get_req_action(), |
|
| 959 | + false, |
|
| 960 | + false |
|
| 961 | + ), |
|
| 962 | + // todo need to add a filter to the template for the help text |
|
| 963 | + // in the Events_Admin_Page core file so we can add further help |
|
| 964 | + 'existing_datetime_ids' => '', |
|
| 965 | + 'total_dtt_rows' => 1, |
|
| 966 | + 'add_new_dtt_help_link' => EEH_Template::get_help_tab_link( |
|
| 967 | + 'add_new_dtt_info', |
|
| 968 | + $this->_adminpage_obj->page_slug, |
|
| 969 | + $this->_adminpage_obj->get_req_action(), |
|
| 970 | + false, |
|
| 971 | + false |
|
| 972 | + ), |
|
| 973 | + //todo need to add this help info id to the Events_Admin_Page core file so we can access it here. |
|
| 974 | + 'datetime_rows' => '', |
|
| 975 | + 'show_tickets_container' => '', |
|
| 976 | + //$this->_adminpage_obj->get_cpt_model_obj()->ID() > 1 ? ' style="display:none;"' : '', |
|
| 977 | + 'ticket_rows' => '', |
|
| 978 | + 'existing_ticket_ids' => '', |
|
| 979 | + 'total_ticket_rows' => 1, |
|
| 980 | + 'ticket_js_structure' => '', |
|
| 981 | + 'ee_collapsible_status' => ' ee-collapsible-open' |
|
| 982 | + //$this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? ' ee-collapsible-closed' : ' ee-collapsible-open' |
|
| 983 | + ); |
|
| 984 | + $timezone = $event instanceof EE_Event ? $event->timezone_string() : null; |
|
| 985 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 986 | + /** |
|
| 987 | + * 1. Start with retrieving Datetimes |
|
| 988 | + * 2. For each datetime get related tickets |
|
| 989 | + * 3. For each ticket get related prices |
|
| 990 | + */ |
|
| 991 | + /** @var EEM_Datetime $datetime_model */ |
|
| 992 | + $datetime_model = EE_Registry::instance()->load_model('Datetime', array($timezone)); |
|
| 993 | + $datetimes = $datetime_model->get_all_event_dates($EVT_ID); |
|
| 994 | + $main_template_args['total_dtt_rows'] = count($datetimes); |
|
| 995 | + /** |
|
| 996 | + * @see https://events.codebasehq.com/projects/event-espresso/tickets/9486 |
|
| 997 | + * for why we are counting $datetime_row and then setting that on the Datetime object |
|
| 998 | + */ |
|
| 999 | + $datetime_row = 1; |
|
| 1000 | + foreach ($datetimes as $datetime) { |
|
| 1001 | + $DTT_ID = $datetime->get('DTT_ID'); |
|
| 1002 | + $datetime->set('DTT_order', $datetime_row); |
|
| 1003 | + $existing_datetime_ids[] = $DTT_ID; |
|
| 1004 | + //tickets attached |
|
| 1005 | + $related_tickets = $datetime->ID() > 0 |
|
| 1006 | + ? $datetime->get_many_related( |
|
| 1007 | + 'Ticket', |
|
| 1008 | + array( |
|
| 1009 | + array( |
|
| 1010 | + 'OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0), |
|
| 1011 | + ), |
|
| 1012 | + 'default_where_conditions' => 'none', |
|
| 1013 | + 'order_by' => array('TKT_order' => 'ASC'), |
|
| 1014 | + ) |
|
| 1015 | + ) |
|
| 1016 | + : array(); |
|
| 1017 | + //if there are no related tickets this is likely a new event OR autodraft |
|
| 1018 | + // event so we need to generate the default tickets because datetimes |
|
| 1019 | + // ALWAYS have at least one related ticket!!. EXCEPT, we dont' do this if there is already more than one |
|
| 1020 | + // datetime on the event. |
|
| 1021 | + if (empty ($related_tickets) && count($datetimes) < 2) { |
|
| 1022 | + /** @var EEM_Ticket $ticket_model */ |
|
| 1023 | + $ticket_model = EE_Registry::instance()->load_model('Ticket'); |
|
| 1024 | + $related_tickets = $ticket_model->get_all_default_tickets(); |
|
| 1025 | + // this should be ordered by TKT_ID, so let's grab the first default ticket |
|
| 1026 | + // (which will be the main default) and ensure it has any default prices added to it (but do NOT save). |
|
| 1027 | + $default_prices = EEM_Price::instance()->get_all_default_prices(); |
|
| 1028 | + $main_default_ticket = reset($related_tickets); |
|
| 1029 | + if ($main_default_ticket instanceof EE_Ticket) { |
|
| 1030 | + foreach ($default_prices as $default_price) { |
|
| 1031 | + if ($default_price instanceof EE_Price && $default_price->is_base_price()) { |
|
| 1032 | + continue; |
|
| 1033 | + } |
|
| 1034 | + $main_default_ticket->cache('Price', $default_price); |
|
| 1035 | + } |
|
| 1036 | + } |
|
| 1037 | + } |
|
| 1038 | + // we can't actually setup rows in this loop yet cause we don't know all |
|
| 1039 | + // the unique tickets for this event yet (tickets are linked through all datetimes). |
|
| 1040 | + // So we're going to temporarily cache some of that information. |
|
| 1041 | + //loop through and setup the ticket rows and make sure the order is set. |
|
| 1042 | + foreach ($related_tickets as $ticket) { |
|
| 1043 | + $TKT_ID = $ticket->get('TKT_ID'); |
|
| 1044 | + $ticket_row = $ticket->get('TKT_row'); |
|
| 1045 | + //we only want unique tickets in our final display!! |
|
| 1046 | + if (! in_array($TKT_ID, $existing_ticket_ids, true)) { |
|
| 1047 | + $existing_ticket_ids[] = $TKT_ID; |
|
| 1048 | + $all_tickets[] = $ticket; |
|
| 1049 | + } |
|
| 1050 | + //temporary cache of this ticket info for this datetime for later processing of datetime rows. |
|
| 1051 | + $datetime_tickets[$DTT_ID][] = $ticket_row; |
|
| 1052 | + //temporary cache of this datetime info for this ticket for later processing of ticket rows. |
|
| 1053 | + if ( |
|
| 1054 | + ! isset($ticket_datetimes[$TKT_ID]) |
|
| 1055 | + || ! in_array($datetime_row, $ticket_datetimes[$TKT_ID], true) |
|
| 1056 | + ) { |
|
| 1057 | + $ticket_datetimes[$TKT_ID][] = $datetime_row; |
|
| 1058 | + } |
|
| 1059 | + } |
|
| 1060 | + $datetime_row++; |
|
| 1061 | + } |
|
| 1062 | + $main_template_args['total_ticket_rows'] = count($existing_ticket_ids); |
|
| 1063 | + $main_template_args['existing_ticket_ids'] = implode(',', $existing_ticket_ids); |
|
| 1064 | + $main_template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids); |
|
| 1065 | + //sort $all_tickets by order |
|
| 1066 | + usort( |
|
| 1067 | + $all_tickets, |
|
| 1068 | + function (EE_Ticket $a, EE_Ticket $b) { |
|
| 1069 | + $a_order = (int)$a->get('TKT_order'); |
|
| 1070 | + $b_order = (int)$b->get('TKT_order'); |
|
| 1071 | + if ($a_order === $b_order) { |
|
| 1072 | + return 0; |
|
| 1073 | + } |
|
| 1074 | + return ($a_order < $b_order) ? -1 : 1; |
|
| 1075 | + } |
|
| 1076 | + ); |
|
| 1077 | + // k NOW we have all the data we need for setting up the dtt rows |
|
| 1078 | + // and ticket rows so we start our dtt loop again. |
|
| 1079 | + $datetime_row = 1; |
|
| 1080 | + foreach ($datetimes as $datetime) { |
|
| 1081 | + $main_template_args['datetime_rows'] .= $this->_get_datetime_row( |
|
| 1082 | + $datetime_row, |
|
| 1083 | + $datetime, |
|
| 1084 | + $datetime_tickets, |
|
| 1085 | + $all_tickets, |
|
| 1086 | + false, |
|
| 1087 | + $datetimes |
|
| 1088 | + ); |
|
| 1089 | + $datetime_row++; |
|
| 1090 | + } |
|
| 1091 | + //then loop through all tickets for the ticket rows. |
|
| 1092 | + $ticket_row = 1; |
|
| 1093 | + foreach ($all_tickets as $ticket) { |
|
| 1094 | + $main_template_args['ticket_rows'] .= $this->_get_ticket_row( |
|
| 1095 | + $ticket_row, |
|
| 1096 | + $ticket, |
|
| 1097 | + $ticket_datetimes, |
|
| 1098 | + $datetimes, |
|
| 1099 | + false, |
|
| 1100 | + $all_tickets |
|
| 1101 | + ); |
|
| 1102 | + $ticket_row++; |
|
| 1103 | + } |
|
| 1104 | + $main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($datetimes, $all_tickets); |
|
| 1105 | + EEH_Template::display_template( |
|
| 1106 | + PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php', |
|
| 1107 | + $main_template_args |
|
| 1108 | + ); |
|
| 1109 | + } |
|
| 1110 | + |
|
| 1111 | + |
|
| 1112 | + |
|
| 1113 | + /** |
|
| 1114 | + * @param int $datetime_row |
|
| 1115 | + * @param EE_Datetime $datetime |
|
| 1116 | + * @param array $datetime_tickets |
|
| 1117 | + * @param array $all_tickets |
|
| 1118 | + * @param bool $default |
|
| 1119 | + * @param array $all_datetimes |
|
| 1120 | + * @return mixed |
|
| 1121 | + * @throws DomainException |
|
| 1122 | + * @throws EE_Error |
|
| 1123 | + */ |
|
| 1124 | + protected function _get_datetime_row( |
|
| 1125 | + $datetime_row, |
|
| 1126 | + EE_Datetime $datetime, |
|
| 1127 | + $datetime_tickets = array(), |
|
| 1128 | + $all_tickets = array(), |
|
| 1129 | + $default = false, |
|
| 1130 | + $all_datetimes = array() |
|
| 1131 | + ) { |
|
| 1132 | + $dtt_display_template_args = array( |
|
| 1133 | + 'dtt_edit_row' => $this->_get_dtt_edit_row($datetime_row, $datetime, $default, $all_datetimes), |
|
| 1134 | + 'dtt_attached_tickets_row' => $this->_get_dtt_attached_tickets_row( |
|
| 1135 | + $datetime_row, |
|
| 1136 | + $datetime, |
|
| 1137 | + $datetime_tickets, |
|
| 1138 | + $all_tickets, |
|
| 1139 | + $default |
|
| 1140 | + ), |
|
| 1141 | + 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
| 1142 | + ); |
|
| 1143 | + return EEH_Template::display_template( |
|
| 1144 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php', |
|
| 1145 | + $dtt_display_template_args, |
|
| 1146 | + true |
|
| 1147 | + ); |
|
| 1148 | + } |
|
| 1149 | + |
|
| 1150 | + |
|
| 1151 | + |
|
| 1152 | + /** |
|
| 1153 | + * This method is used to generate a dtt fields edit row. |
|
| 1154 | + * The same row is used to generate a row with valid DTT objects |
|
| 1155 | + * and the default row that is used as the skeleton by the js. |
|
| 1156 | + * |
|
| 1157 | + * @param int $datetime_row The row number for the row being generated. |
|
| 1158 | + * @param EE_Datetime $datetime |
|
| 1159 | + * @param bool $default Whether a default row is being generated or not. |
|
| 1160 | + * @param EE_Datetime[] $all_datetimes This is the array of all datetimes used in the editor. |
|
| 1161 | + * @return string |
|
| 1162 | + * @throws DomainException |
|
| 1163 | + * @throws EE_Error |
|
| 1164 | + */ |
|
| 1165 | + protected function _get_dtt_edit_row($datetime_row, $datetime, $default, $all_datetimes) |
|
| 1166 | + { |
|
| 1167 | + // if the incoming $datetime object is NOT an instance of EE_Datetime then force default to true. |
|
| 1168 | + $default = ! $datetime instanceof EE_Datetime ? true : $default; |
|
| 1169 | + $template_args = array( |
|
| 1170 | + 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
| 1171 | + 'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes', |
|
| 1172 | + 'edit_dtt_expanded' => '', |
|
| 1173 | + 'DTT_ID' => $default ? '' : $datetime->ID(), |
|
| 1174 | + 'DTT_name' => $default ? '' : $datetime->name(), |
|
| 1175 | + 'DTT_description' => $default ? '' : $datetime->description(), |
|
| 1176 | + 'DTT_EVT_start' => $default ? '' : $datetime->start_date($this->_date_time_format), |
|
| 1177 | + 'DTT_EVT_end' => $default ? '' : $datetime->end_date($this->_date_time_format), |
|
| 1178 | + 'DTT_reg_limit' => $default |
|
| 1179 | + ? '' |
|
| 1180 | + : $datetime->get_pretty( |
|
| 1181 | + 'DTT_reg_limit', |
|
| 1182 | + 'input' |
|
| 1183 | + ), |
|
| 1184 | + 'DTT_order' => $default ? 'DTTNUM' : $datetime_row, |
|
| 1185 | + 'dtt_sold' => $default ? '0' : $datetime->get('DTT_sold'), |
|
| 1186 | + 'dtt_reserved' => $default ? '0' : $datetime->reserved(), |
|
| 1187 | + 'clone_icon' => ! empty($datetime) && $datetime->get('DTT_sold') > 0 |
|
| 1188 | + ? '' |
|
| 1189 | + : 'clone-icon ee-icon ee-icon-clone clickable', |
|
| 1190 | + 'trash_icon' => ! empty($datetime) && $datetime->get('DTT_sold') > 0 |
|
| 1191 | + ? 'ee-lock-icon' |
|
| 1192 | + : 'trash-icon dashicons dashicons-post-trash clickable', |
|
| 1193 | + 'reg_list_url' => $default || ! $datetime->event() instanceof \EE_Event |
|
| 1194 | + ? '' |
|
| 1195 | + : EE_Admin_Page::add_query_args_and_nonce( |
|
| 1196 | + array('event_id' => $datetime->event()->ID(), 'datetime_id' => $datetime->ID()), |
|
| 1197 | + REG_ADMIN_URL |
|
| 1198 | + ), |
|
| 1199 | + ); |
|
| 1200 | + $template_args['show_trash'] = count($all_datetimes) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon' |
|
| 1201 | + ? ' style="display:none"' |
|
| 1202 | + : ''; |
|
| 1203 | + //allow filtering of template args at this point. |
|
| 1204 | + $template_args = apply_filters( |
|
| 1205 | + 'FHEE__espresso_events_Pricing_Hooks___get_dtt_edit_row__template_args', |
|
| 1206 | + $template_args, |
|
| 1207 | + $datetime_row, |
|
| 1208 | + $datetime, |
|
| 1209 | + $default, |
|
| 1210 | + $all_datetimes, |
|
| 1211 | + $this->_is_creating_event |
|
| 1212 | + ); |
|
| 1213 | + return EEH_Template::display_template( |
|
| 1214 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php', |
|
| 1215 | + $template_args, |
|
| 1216 | + true |
|
| 1217 | + ); |
|
| 1218 | + } |
|
| 1219 | + |
|
| 1220 | + |
|
| 1221 | + |
|
| 1222 | + /** |
|
| 1223 | + * @param int $datetime_row |
|
| 1224 | + * @param EE_Datetime $datetime |
|
| 1225 | + * @param array $datetime_tickets |
|
| 1226 | + * @param array $all_tickets |
|
| 1227 | + * @param bool $default |
|
| 1228 | + * @return mixed |
|
| 1229 | + * @throws DomainException |
|
| 1230 | + * @throws EE_Error |
|
| 1231 | + */ |
|
| 1232 | + protected function _get_dtt_attached_tickets_row( |
|
| 1233 | + $datetime_row, |
|
| 1234 | + $datetime, |
|
| 1235 | + $datetime_tickets = array(), |
|
| 1236 | + $all_tickets = array(), |
|
| 1237 | + $default |
|
| 1238 | + ) { |
|
| 1239 | + $template_args = array( |
|
| 1240 | + 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
|
| 1241 | + 'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes', |
|
| 1242 | + 'DTT_description' => $default ? '' : $datetime->description(), |
|
| 1243 | + 'datetime_tickets_list' => $default ? '<li class="hidden"></li>' : '', |
|
| 1244 | + 'show_tickets_row' => ' style="display:none;"', |
|
| 1245 | + 'add_new_datetime_ticket_help_link' => EEH_Template::get_help_tab_link( |
|
| 1246 | + 'add_new_ticket_via_datetime', |
|
| 1247 | + $this->_adminpage_obj->page_slug, |
|
| 1248 | + $this->_adminpage_obj->get_req_action(), |
|
| 1249 | + false, |
|
| 1250 | + false |
|
| 1251 | + ), |
|
| 1252 | + //todo need to add this help info id to the Events_Admin_Page core file so we can access it here. |
|
| 1253 | + 'DTT_ID' => $default ? '' : $datetime->ID(), |
|
| 1254 | + ); |
|
| 1255 | + //need to setup the list items (but only if this isn't a default skeleton setup) |
|
| 1256 | + if (! $default) { |
|
| 1257 | + $ticket_row = 1; |
|
| 1258 | + foreach ($all_tickets as $ticket) { |
|
| 1259 | + $template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
|
| 1260 | + $datetime_row, |
|
| 1261 | + $ticket_row, |
|
| 1262 | + $datetime, |
|
| 1263 | + $ticket, |
|
| 1264 | + $datetime_tickets, |
|
| 1265 | + $default |
|
| 1266 | + ); |
|
| 1267 | + $ticket_row++; |
|
| 1268 | + } |
|
| 1269 | + } |
|
| 1270 | + //filter template args at this point |
|
| 1271 | + $template_args = apply_filters( |
|
| 1272 | + 'FHEE__espresso_events_Pricing_Hooks___get_dtt_attached_ticket_row__template_args', |
|
| 1273 | + $template_args, |
|
| 1274 | + $datetime_row, |
|
| 1275 | + $datetime, |
|
| 1276 | + $datetime_tickets, |
|
| 1277 | + $all_tickets, |
|
| 1278 | + $default, |
|
| 1279 | + $this->_is_creating_event |
|
| 1280 | + ); |
|
| 1281 | + return EEH_Template::display_template( |
|
| 1282 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php', |
|
| 1283 | + $template_args, |
|
| 1284 | + true |
|
| 1285 | + ); |
|
| 1286 | + } |
|
| 1287 | + |
|
| 1288 | + |
|
| 1289 | + |
|
| 1290 | + /** |
|
| 1291 | + * @param int $datetime_row |
|
| 1292 | + * @param int $ticket_row |
|
| 1293 | + * @param EE_Datetime $datetime |
|
| 1294 | + * @param EE_Ticket $ticket |
|
| 1295 | + * @param array $datetime_tickets |
|
| 1296 | + * @param bool $default |
|
| 1297 | + * @return mixed |
|
| 1298 | + * @throws DomainException |
|
| 1299 | + * @throws EE_Error |
|
| 1300 | + */ |
|
| 1301 | + protected function _get_datetime_tickets_list_item( |
|
| 1302 | + $datetime_row, |
|
| 1303 | + $ticket_row, |
|
| 1304 | + $datetime, |
|
| 1305 | + $ticket, |
|
| 1306 | + $datetime_tickets = array(), |
|
| 1307 | + $default |
|
| 1308 | + ) { |
|
| 1309 | + $dtt_tkts = $datetime instanceof EE_Datetime && isset($datetime_tickets[$datetime->ID()]) |
|
| 1310 | + ? $datetime_tickets[$datetime->ID()] |
|
| 1311 | + : array(); |
|
| 1312 | + $display_row = $ticket instanceof EE_Ticket ? $ticket->get('TKT_row') : 0; |
|
| 1313 | + $no_ticket = $default && empty($ticket); |
|
| 1314 | + $template_args = array( |
|
| 1315 | + 'dtt_row' => $default |
|
| 1316 | + ? 'DTTNUM' |
|
| 1317 | + : $datetime_row, |
|
| 1318 | + 'tkt_row' => $no_ticket |
|
| 1319 | + ? 'TICKETNUM' |
|
| 1320 | + : $ticket_row, |
|
| 1321 | + 'datetime_ticket_checked' => in_array($display_row, $dtt_tkts, true) |
|
| 1322 | + ? ' checked="checked"' |
|
| 1323 | + : '', |
|
| 1324 | + 'ticket_selected' => in_array($display_row, $dtt_tkts, true) |
|
| 1325 | + ? ' ticket-selected' |
|
| 1326 | + : '', |
|
| 1327 | + 'TKT_name' => $no_ticket |
|
| 1328 | + ? 'TKTNAME' |
|
| 1329 | + : $ticket->get('TKT_name'), |
|
| 1330 | + 'tkt_status_class' => $no_ticket || $this->_is_creating_event |
|
| 1331 | + ? ' tkt-status-' . EE_Ticket::onsale |
|
| 1332 | + : ' tkt-status-' . $ticket->ticket_status(), |
|
| 1333 | + ); |
|
| 1334 | + //filter template args |
|
| 1335 | + $template_args = apply_filters( |
|
| 1336 | + 'FHEE__espresso_events_Pricing_Hooks___get_datetime_tickets_list_item__template_args', |
|
| 1337 | + $template_args, |
|
| 1338 | + $datetime_row, |
|
| 1339 | + $ticket_row, |
|
| 1340 | + $datetime, |
|
| 1341 | + $ticket, |
|
| 1342 | + $datetime_tickets, |
|
| 1343 | + $default, |
|
| 1344 | + $this->_is_creating_event |
|
| 1345 | + ); |
|
| 1346 | + return EEH_Template::display_template( |
|
| 1347 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php', |
|
| 1348 | + $template_args, |
|
| 1349 | + true |
|
| 1350 | + ); |
|
| 1351 | + } |
|
| 1352 | + |
|
| 1353 | + |
|
| 1354 | + |
|
| 1355 | + /** |
|
| 1356 | + * This generates the ticket row for tickets. |
|
| 1357 | + * This same method is used to generate both the actual rows and the js skeleton row |
|
| 1358 | + * (when default === true) |
|
| 1359 | + * |
|
| 1360 | + * @param int $ticket_row Represents the row number being generated. |
|
| 1361 | + * @param $ticket |
|
| 1362 | + * @param EE_Datetime[] $ticket_datetimes Either an array of all datetimes on all tickets indexed by each ticket |
|
| 1363 | + * or empty for default |
|
| 1364 | + * @param EE_Datetime[] $all_datetimes All Datetimes on the event or empty for default. |
|
| 1365 | + * @param bool $default Whether default row being generated or not. |
|
| 1366 | + * @param EE_Ticket[] $all_tickets This is an array of all tickets attached to the event |
|
| 1367 | + * (or empty in the case of defaults) |
|
| 1368 | + * @return mixed |
|
| 1369 | + * @throws DomainException |
|
| 1370 | + * @throws EE_Error |
|
| 1371 | + */ |
|
| 1372 | + protected function _get_ticket_row( |
|
| 1373 | + $ticket_row, |
|
| 1374 | + $ticket, |
|
| 1375 | + $ticket_datetimes, |
|
| 1376 | + $all_datetimes, |
|
| 1377 | + $default = false, |
|
| 1378 | + $all_tickets = array() |
|
| 1379 | + ) { |
|
| 1380 | + // if $ticket is not an instance of EE_Ticket then force default to true. |
|
| 1381 | + $default = ! $ticket instanceof EE_Ticket ? true : $default; |
|
| 1382 | + $prices = ! empty($ticket) && ! $default ? $ticket->get_many_related('Price', |
|
| 1383 | + array('default_where_conditions' => 'none', 'order_by' => array('PRC_order' => 'ASC'))) : array(); |
|
| 1384 | + // if there is only one price (which would be the base price) |
|
| 1385 | + // or NO prices and this ticket is a default ticket, |
|
| 1386 | + // let's just make sure there are no cached default prices on the object. |
|
| 1387 | + // This is done by not including any query_params. |
|
| 1388 | + if ($ticket instanceof EE_Ticket && $ticket->is_default() && (count($prices) === 1 || empty($prices))) { |
|
| 1389 | + $prices = $ticket->prices(); |
|
| 1390 | + } |
|
| 1391 | + // check if we're dealing with a default ticket in which case |
|
| 1392 | + // we don't want any starting_ticket_datetime_row values set |
|
| 1393 | + // (otherwise there won't be any new relationships created for tickets based off of the default ticket). |
|
| 1394 | + // This will future proof in case there is ever any behaviour change between what the primary_key defaults to. |
|
| 1395 | + $default_dtt = $default || ($ticket instanceof EE_Ticket && $ticket->is_default()); |
|
| 1396 | + $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()]) |
|
| 1397 | + ? $ticket_datetimes[$ticket->ID()] |
|
| 1398 | + : array(); |
|
| 1399 | + $ticket_subtotal = $default ? 0 : $ticket->get_ticket_subtotal(); |
|
| 1400 | + $base_price = $default ? null : $ticket->base_price(); |
|
| 1401 | + $count_price_mods = EEM_Price::instance()->get_all_default_prices(true); |
|
| 1402 | + //breaking out complicated condition for ticket_status |
|
| 1403 | + if ($default) { |
|
| 1404 | + $ticket_status_class = ' tkt-status-' . EE_Ticket::onsale; |
|
| 1405 | + } else { |
|
| 1406 | + $ticket_status_class = $ticket->is_default() |
|
| 1407 | + ? ' tkt-status-' . EE_Ticket::onsale |
|
| 1408 | + : ' tkt-status-' . $ticket->ticket_status(); |
|
| 1409 | + } |
|
| 1410 | + //breaking out complicated condition for TKT_taxable |
|
| 1411 | + if ($default) { |
|
| 1412 | + $TKT_taxable = ''; |
|
| 1413 | + } else { |
|
| 1414 | + $TKT_taxable = $ticket->taxable() |
|
| 1415 | + ? ' checked="checked"' |
|
| 1416 | + : ''; |
|
| 1417 | + } |
|
| 1418 | + if ($default) { |
|
| 1419 | + $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence'); |
|
| 1420 | + } elseif ($ticket->is_default()) { |
|
| 1421 | + $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence'); |
|
| 1422 | + } else { |
|
| 1423 | + $TKT_status = $ticket->ticket_status(true); |
|
| 1424 | + } |
|
| 1425 | + if ($default) { |
|
| 1426 | + $TKT_min = ''; |
|
| 1427 | + } else { |
|
| 1428 | + $TKT_min = $ticket->min(); |
|
| 1429 | + if ($TKT_min === -1 || $TKT_min === 0) { |
|
| 1430 | + $TKT_min = ''; |
|
| 1431 | + } |
|
| 1432 | + } |
|
| 1433 | + $template_args = array( |
|
| 1434 | + 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
| 1435 | + 'TKT_order' => $default ? 'TICKETNUM' : $ticket_row, |
|
| 1436 | + //on initial page load this will always be the correct order. |
|
| 1437 | + 'tkt_status_class' => $ticket_status_class, |
|
| 1438 | + 'display_edit_tkt_row' => ' style="display:none;"', |
|
| 1439 | + 'edit_tkt_expanded' => '', |
|
| 1440 | + 'edit_tickets_name' => $default ? 'TICKETNAMEATTR' : 'edit_tickets', |
|
| 1441 | + 'TKT_name' => $default ? '' : $ticket->name(), |
|
| 1442 | + 'TKT_start_date' => $default |
|
| 1443 | + ? '' |
|
| 1444 | + : $ticket->get_date('TKT_start_date', $this->_date_time_format), |
|
| 1445 | + 'TKT_end_date' => $default |
|
| 1446 | + ? '' |
|
| 1447 | + : $ticket->get_date('TKT_end_date', $this->_date_time_format), |
|
| 1448 | + 'TKT_status' => $TKT_status, |
|
| 1449 | + 'TKT_price' => $default |
|
| 1450 | + ? '' |
|
| 1451 | + : EEH_Template::format_currency( |
|
| 1452 | + $ticket->get_ticket_total_with_taxes(), |
|
| 1453 | + false, |
|
| 1454 | + false |
|
| 1455 | + ), |
|
| 1456 | + 'TKT_price_code' => EE_Registry::instance()->CFG->currency->code, |
|
| 1457 | + 'TKT_price_amount' => $default ? 0 : $ticket_subtotal, |
|
| 1458 | + 'TKT_qty' => $default |
|
| 1459 | + ? '' |
|
| 1460 | + : $ticket->get_pretty('TKT_qty', 'symbol'), |
|
| 1461 | + 'TKT_qty_for_input' => $default |
|
| 1462 | + ? '' |
|
| 1463 | + : $ticket->get_pretty('TKT_qty', 'input'), |
|
| 1464 | + 'TKT_uses' => $default |
|
| 1465 | + ? '' |
|
| 1466 | + : $ticket->get_pretty('TKT_uses', 'input'), |
|
| 1467 | + 'TKT_min' => $TKT_min, |
|
| 1468 | + 'TKT_max' => $default |
|
| 1469 | + ? '' |
|
| 1470 | + : $ticket->get_pretty('TKT_max', 'input'), |
|
| 1471 | + 'TKT_sold' => $default ? 0 : $ticket->tickets_sold('ticket'), |
|
| 1472 | + 'TKT_reserved' => $default ? 0 : $ticket->reserved(), |
|
| 1473 | + 'TKT_registrations' => $default |
|
| 1474 | + ? 0 |
|
| 1475 | + : $ticket->count_registrations( |
|
| 1476 | + array( |
|
| 1477 | + array( |
|
| 1478 | + 'STS_ID' => array( |
|
| 1479 | + '!=', |
|
| 1480 | + EEM_Registration::status_id_incomplete, |
|
| 1481 | + ), |
|
| 1482 | + ), |
|
| 1483 | + ) |
|
| 1484 | + ), |
|
| 1485 | + 'TKT_ID' => $default ? 0 : $ticket->ID(), |
|
| 1486 | + 'TKT_description' => $default ? '' : $ticket->description(), |
|
| 1487 | + 'TKT_is_default' => $default ? 0 : $ticket->is_default(), |
|
| 1488 | + 'TKT_required' => $default ? 0 : $ticket->required(), |
|
| 1489 | + 'TKT_is_default_selector' => '', |
|
| 1490 | + 'ticket_price_rows' => '', |
|
| 1491 | + 'TKT_base_price' => $default || ! $base_price instanceof EE_Price |
|
| 1492 | + ? '' |
|
| 1493 | + : $base_price->get_pretty('PRC_amount', 'localized_float'), |
|
| 1494 | + 'TKT_base_price_ID' => $default || ! $base_price instanceof EE_Price ? 0 : $base_price->ID(), |
|
| 1495 | + 'show_price_modifier' => count($prices) > 1 || ($default && $count_price_mods > 0) |
|
| 1496 | + ? '' |
|
| 1497 | + : ' style="display:none;"', |
|
| 1498 | + 'show_price_mod_button' => count($prices) > 1 |
|
| 1499 | + || ($default && $count_price_mods > 0) |
|
| 1500 | + || (! $default && $ticket->deleted()) |
|
| 1501 | + ? ' style="display:none;"' |
|
| 1502 | + : '', |
|
| 1503 | + 'total_price_rows' => count($prices) > 1 ? count($prices) : 1, |
|
| 1504 | + 'ticket_datetimes_list' => $default ? '<li class="hidden"></li>' : '', |
|
| 1505 | + 'starting_ticket_datetime_rows' => $default || $default_dtt ? '' : implode(',', $tkt_datetimes), |
|
| 1506 | + 'ticket_datetime_rows' => $default ? '' : implode(',', $tkt_datetimes), |
|
| 1507 | + 'existing_ticket_price_ids' => $default ? '' : implode(',', array_keys($prices)), |
|
| 1508 | + 'ticket_template_id' => $default ? 0 : $ticket->get('TTM_ID'), |
|
| 1509 | + 'TKT_taxable' => $TKT_taxable, |
|
| 1510 | + 'display_subtotal' => $ticket instanceof EE_Ticket && $ticket->taxable() |
|
| 1511 | + ? '' |
|
| 1512 | + : ' style="display:none"', |
|
| 1513 | + 'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign, |
|
| 1514 | + 'TKT_subtotal_amount_display' => EEH_Template::format_currency( |
|
| 1515 | + $ticket_subtotal, |
|
| 1516 | + false, |
|
| 1517 | + false |
|
| 1518 | + ), |
|
| 1519 | + 'TKT_subtotal_amount' => $ticket_subtotal, |
|
| 1520 | + 'tax_rows' => $this->_get_tax_rows($ticket_row, $ticket), |
|
| 1521 | + 'disabled' => $ticket instanceof EE_Ticket && $ticket->deleted(), |
|
| 1522 | + 'ticket_archive_class' => $ticket instanceof EE_Ticket && $ticket->deleted() |
|
| 1523 | + ? ' ticket-archived' |
|
| 1524 | + : '', |
|
| 1525 | + 'trash_icon' => $ticket instanceof EE_Ticket |
|
| 1526 | + && $ticket->deleted() |
|
| 1527 | + && ! $ticket->is_permanently_deleteable() |
|
| 1528 | + ? 'ee-lock-icon ' |
|
| 1529 | + : 'trash-icon dashicons dashicons-post-trash clickable', |
|
| 1530 | + 'clone_icon' => $ticket instanceof EE_Ticket && $ticket->deleted() |
|
| 1531 | + ? '' |
|
| 1532 | + : 'clone-icon ee-icon ee-icon-clone clickable', |
|
| 1533 | + ); |
|
| 1534 | + $template_args['trash_hidden'] = count($all_tickets) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon' |
|
| 1535 | + ? ' style="display:none"' |
|
| 1536 | + : ''; |
|
| 1537 | + //handle rows that should NOT be empty |
|
| 1538 | + if (empty($template_args['TKT_start_date'])) { |
|
| 1539 | + //if empty then the start date will be now. |
|
| 1540 | + $template_args['TKT_start_date'] = date($this->_date_time_format, |
|
| 1541 | + current_time('timestamp')); |
|
| 1542 | + $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
| 1543 | + } |
|
| 1544 | + if (empty($template_args['TKT_end_date'])) { |
|
| 1545 | + //get the earliest datetime (if present); |
|
| 1546 | + $earliest_dtt = $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 |
|
| 1547 | + ? $this->_adminpage_obj->get_cpt_model_obj()->get_first_related( |
|
| 1548 | + 'Datetime', |
|
| 1549 | + array('order_by' => array('DTT_EVT_start' => 'ASC')) |
|
| 1550 | + ) |
|
| 1551 | + : null; |
|
| 1552 | + if (! empty($earliest_dtt)) { |
|
| 1553 | + $template_args['TKT_end_date'] = $earliest_dtt->get_datetime( |
|
| 1554 | + 'DTT_EVT_start', |
|
| 1555 | + $this->_date_time_format |
|
| 1556 | + ); |
|
| 1557 | + } else { |
|
| 1558 | + //default so let's just use what's been set for the default date-time which is 30 days from now. |
|
| 1559 | + $template_args['TKT_end_date'] = date( |
|
| 1560 | + $this->_date_time_format, |
|
| 1561 | + mktime(24, 0, 0, date('m'), date('d') + 29, date('Y') |
|
| 1562 | + ) |
|
| 1563 | + ); |
|
| 1564 | + } |
|
| 1565 | + $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
| 1566 | + } |
|
| 1567 | + //generate ticket_datetime items |
|
| 1568 | + if (! $default) { |
|
| 1569 | + $datetime_row = 1; |
|
| 1570 | + foreach ($all_datetimes as $datetime) { |
|
| 1571 | + $template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
|
| 1572 | + $datetime_row, |
|
| 1573 | + $ticket_row, |
|
| 1574 | + $datetime, |
|
| 1575 | + $ticket, |
|
| 1576 | + $ticket_datetimes, |
|
| 1577 | + $default |
|
| 1578 | + ); |
|
| 1579 | + $datetime_row++; |
|
| 1580 | + } |
|
| 1581 | + } |
|
| 1582 | + $price_row = 1; |
|
| 1583 | + foreach ($prices as $price) { |
|
| 1584 | + if (! $price instanceof EE_Price) { |
|
| 1585 | + continue; |
|
| 1586 | + } |
|
| 1587 | + if ($price->is_base_price()) { |
|
| 1588 | + $price_row++; |
|
| 1589 | + continue; |
|
| 1590 | + } |
|
| 1591 | + $show_trash = !((count($prices) > 1 && $price_row === 1) || count($prices) === 1); |
|
| 1592 | + $show_create = !(count($prices) > 1 && count($prices) !== $price_row); |
|
| 1593 | + $template_args['ticket_price_rows'] .= $this->_get_ticket_price_row( |
|
| 1594 | + $ticket_row, |
|
| 1595 | + $price_row, |
|
| 1596 | + $price, |
|
| 1597 | + $default, |
|
| 1598 | + $ticket, |
|
| 1599 | + $show_trash, |
|
| 1600 | + $show_create |
|
| 1601 | + ); |
|
| 1602 | + $price_row++; |
|
| 1603 | + } |
|
| 1604 | + //filter $template_args |
|
| 1605 | + $template_args = apply_filters( |
|
| 1606 | + 'FHEE__espresso_events_Pricing_Hooks___get_ticket_row__template_args', |
|
| 1607 | + $template_args, |
|
| 1608 | + $ticket_row, |
|
| 1609 | + $ticket, |
|
| 1610 | + $ticket_datetimes, |
|
| 1611 | + $all_datetimes, |
|
| 1612 | + $default, |
|
| 1613 | + $all_tickets, |
|
| 1614 | + $this->_is_creating_event |
|
| 1615 | + ); |
|
| 1616 | + return EEH_Template::display_template( |
|
| 1617 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php', |
|
| 1618 | + $template_args, |
|
| 1619 | + true |
|
| 1620 | + ); |
|
| 1621 | + } |
|
| 1622 | + |
|
| 1623 | + |
|
| 1624 | + |
|
| 1625 | + /** |
|
| 1626 | + * @param int $ticket_row |
|
| 1627 | + * @param EE_Ticket|null $ticket |
|
| 1628 | + * @return string |
|
| 1629 | + * @throws DomainException |
|
| 1630 | + * @throws EE_Error |
|
| 1631 | + */ |
|
| 1632 | + protected function _get_tax_rows($ticket_row, $ticket) |
|
| 1633 | + { |
|
| 1634 | + $tax_rows = ''; |
|
| 1635 | + /** @var EE_Price[] $taxes */ |
|
| 1636 | + $taxes = empty($ticket) ? EE_Taxes::get_taxes_for_admin() : $ticket->get_ticket_taxes_for_admin(); |
|
| 1637 | + foreach ($taxes as $tax) { |
|
| 1638 | + $tax_added = $this->_get_tax_added($tax, $ticket); |
|
| 1639 | + $template_args = array( |
|
| 1640 | + 'display_tax' => ! empty($ticket) && $ticket->get('TKT_taxable') |
|
| 1641 | + ? '' |
|
| 1642 | + : ' style="display:none;"', |
|
| 1643 | + 'tax_id' => $tax->ID(), |
|
| 1644 | + 'tkt_row' => $ticket_row, |
|
| 1645 | + 'tax_label' => $tax->get('PRC_name'), |
|
| 1646 | + 'tax_added' => $tax_added, |
|
| 1647 | + 'tax_added_display' => EEH_Template::format_currency($tax_added, false, false), |
|
| 1648 | + 'tax_amount' => $tax->get('PRC_amount'), |
|
| 1649 | + ); |
|
| 1650 | + $template_args = apply_filters( |
|
| 1651 | + 'FHEE__espresso_events_Pricing_Hooks___get_tax_rows__template_args', |
|
| 1652 | + $template_args, |
|
| 1653 | + $ticket_row, |
|
| 1654 | + $ticket, |
|
| 1655 | + $this->_is_creating_event |
|
| 1656 | + ); |
|
| 1657 | + $tax_rows .= EEH_Template::display_template( |
|
| 1658 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php', |
|
| 1659 | + $template_args, |
|
| 1660 | + true |
|
| 1661 | + ); |
|
| 1662 | + } |
|
| 1663 | + return $tax_rows; |
|
| 1664 | + } |
|
| 1665 | + |
|
| 1666 | + |
|
| 1667 | + |
|
| 1668 | + /** |
|
| 1669 | + * @param EE_Price $tax |
|
| 1670 | + * @param EE_Ticket|null $ticket |
|
| 1671 | + * @return float|int |
|
| 1672 | + * @throws EE_Error |
|
| 1673 | + */ |
|
| 1674 | + protected function _get_tax_added(EE_Price $tax, $ticket) |
|
| 1675 | + { |
|
| 1676 | + $subtotal = empty($ticket) ? 0 : $ticket->get_ticket_subtotal(); |
|
| 1677 | + return $subtotal * $tax->get('PRC_amount') / 100; |
|
| 1678 | + } |
|
| 1679 | + |
|
| 1680 | + |
|
| 1681 | + |
|
| 1682 | + /** |
|
| 1683 | + * @param int $ticket_row |
|
| 1684 | + * @param int $price_row |
|
| 1685 | + * @param EE_Price|null $price |
|
| 1686 | + * @param bool $default |
|
| 1687 | + * @param EE_Ticket|null $ticket |
|
| 1688 | + * @param bool $show_trash |
|
| 1689 | + * @param bool $show_create |
|
| 1690 | + * @return mixed |
|
| 1691 | + * @throws DomainException |
|
| 1692 | + * @throws EE_Error |
|
| 1693 | + */ |
|
| 1694 | + protected function _get_ticket_price_row( |
|
| 1695 | + $ticket_row, |
|
| 1696 | + $price_row, |
|
| 1697 | + $price, |
|
| 1698 | + $default, |
|
| 1699 | + $ticket, |
|
| 1700 | + $show_trash = true, |
|
| 1701 | + $show_create = true |
|
| 1702 | + ) { |
|
| 1703 | + $send_disabled = ! empty($ticket) && $ticket->get('TKT_deleted'); |
|
| 1704 | + $template_args = array( |
|
| 1705 | + 'tkt_row' => $default && empty($ticket) |
|
| 1706 | + ? 'TICKETNUM' |
|
| 1707 | + : $ticket_row, |
|
| 1708 | + 'PRC_order' => $default && empty($price) |
|
| 1709 | + ? 'PRICENUM' |
|
| 1710 | + : $price_row, |
|
| 1711 | + 'edit_prices_name' => $default && empty($price) |
|
| 1712 | + ? 'PRICENAMEATTR' |
|
| 1713 | + : 'edit_prices', |
|
| 1714 | + 'price_type_selector' => $default && empty($price) |
|
| 1715 | + ? $this->_get_base_price_template($ticket_row, $price_row, $price, $default) |
|
| 1716 | + : $this->_get_price_type_selector($ticket_row, $price_row, $price, $default, $send_disabled), |
|
| 1717 | + 'PRC_ID' => $default && empty($price) |
|
| 1718 | + ? 0 |
|
| 1719 | + : $price->ID(), |
|
| 1720 | + 'PRC_is_default' => $default && empty($price) |
|
| 1721 | + ? 0 |
|
| 1722 | + : $price->get('PRC_is_default'), |
|
| 1723 | + 'PRC_name' => $default && empty($price) |
|
| 1724 | + ? '' |
|
| 1725 | + : $price->get('PRC_name'), |
|
| 1726 | + 'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign, |
|
| 1727 | + 'show_plus_or_minus' => $default && empty($price) |
|
| 1728 | + ? '' |
|
| 1729 | + : ' style="display:none;"', |
|
| 1730 | + 'show_plus' => ($default && empty($price)) || ($price->is_discount() || $price->is_base_price()) |
|
| 1731 | + ? ' style="display:none;"' |
|
| 1732 | + : '', |
|
| 1733 | + 'show_minus' => ($default && empty($price)) || ! $price->is_discount() |
|
| 1734 | + ? ' style="display:none;"' |
|
| 1735 | + : '', |
|
| 1736 | + 'show_currency_symbol' => ($default && empty($price)) || $price->is_percent() |
|
| 1737 | + ? ' style="display:none"' |
|
| 1738 | + : '', |
|
| 1739 | + 'PRC_amount' => $default && empty($price) |
|
| 1740 | + ? 0 |
|
| 1741 | + : $price->get_pretty('PRC_amount', |
|
| 1742 | + 'localized_float'), |
|
| 1743 | + 'show_percentage' => ($default && empty($price)) || ! $price->is_percent() |
|
| 1744 | + ? ' style="display:none;"' |
|
| 1745 | + : '', |
|
| 1746 | + 'show_trash_icon' => $show_trash |
|
| 1747 | + ? '' |
|
| 1748 | + : ' style="display:none;"', |
|
| 1749 | + 'show_create_button' => $show_create |
|
| 1750 | + ? '' |
|
| 1751 | + : ' style="display:none;"', |
|
| 1752 | + 'PRC_desc' => $default && empty($price) |
|
| 1753 | + ? '' |
|
| 1754 | + : $price->get('PRC_desc'), |
|
| 1755 | + 'disabled' => ! empty($ticket) && $ticket->get('TKT_deleted'), |
|
| 1756 | + ); |
|
| 1757 | + $template_args = apply_filters( |
|
| 1758 | + 'FHEE__espresso_events_Pricing_Hooks___get_ticket_price_row__template_args', |
|
| 1759 | + $template_args, |
|
| 1760 | + $ticket_row, |
|
| 1761 | + $price_row, |
|
| 1762 | + $price, |
|
| 1763 | + $default, |
|
| 1764 | + $ticket, |
|
| 1765 | + $show_trash, |
|
| 1766 | + $show_create, |
|
| 1767 | + $this->_is_creating_event |
|
| 1768 | + ); |
|
| 1769 | + return EEH_Template::display_template( |
|
| 1770 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php', |
|
| 1771 | + $template_args, |
|
| 1772 | + true |
|
| 1773 | + ); |
|
| 1774 | + } |
|
| 1775 | + |
|
| 1776 | + |
|
| 1777 | + |
|
| 1778 | + /** |
|
| 1779 | + * @param int $ticket_row |
|
| 1780 | + * @param int $price_row |
|
| 1781 | + * @param EE_Price $price |
|
| 1782 | + * @param bool $default |
|
| 1783 | + * @param bool $disabled |
|
| 1784 | + * @return mixed |
|
| 1785 | + * @throws DomainException |
|
| 1786 | + * @throws EE_Error |
|
| 1787 | + */ |
|
| 1788 | + protected function _get_price_type_selector($ticket_row, $price_row, $price, $default, $disabled = false) |
|
| 1789 | + { |
|
| 1790 | + if ($price->is_base_price()) { |
|
| 1791 | + return $this->_get_base_price_template($ticket_row, $price_row, $price, $default); |
|
| 1792 | + } |
|
| 1793 | + return $this->_get_price_modifier_template($ticket_row, $price_row, $price, $default, $disabled); |
|
| 1794 | + } |
|
| 1795 | + |
|
| 1796 | + |
|
| 1797 | + |
|
| 1798 | + /** |
|
| 1799 | + * @param int $ticket_row |
|
| 1800 | + * @param int $price_row |
|
| 1801 | + * @param EE_Price $price |
|
| 1802 | + * @param bool $default |
|
| 1803 | + * @return mixed |
|
| 1804 | + * @throws DomainException |
|
| 1805 | + * @throws EE_Error |
|
| 1806 | + */ |
|
| 1807 | + protected function _get_base_price_template($ticket_row, $price_row, $price, $default) |
|
| 1808 | + { |
|
| 1809 | + $template_args = array( |
|
| 1810 | + 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
| 1811 | + 'PRC_order' => $default && empty($price) ? 'PRICENUM' : $price_row, |
|
| 1812 | + 'PRT_ID' => $default && empty($price) ? 1 : $price->get('PRT_ID'), |
|
| 1813 | + 'PRT_name' => esc_html__('Price', 'event_espresso'), |
|
| 1814 | + 'price_selected_operator' => '+', |
|
| 1815 | + 'price_selected_is_percent' => 0, |
|
| 1816 | + ); |
|
| 1817 | + $template_args = apply_filters( |
|
| 1818 | + 'FHEE__espresso_events_Pricing_Hooks___get_base_price_template__template_args', |
|
| 1819 | + $template_args, |
|
| 1820 | + $ticket_row, |
|
| 1821 | + $price_row, |
|
| 1822 | + $price, |
|
| 1823 | + $default, |
|
| 1824 | + $this->_is_creating_event |
|
| 1825 | + ); |
|
| 1826 | + return EEH_Template::display_template( |
|
| 1827 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php', |
|
| 1828 | + $template_args, |
|
| 1829 | + true |
|
| 1830 | + ); |
|
| 1831 | + } |
|
| 1832 | + |
|
| 1833 | + |
|
| 1834 | + |
|
| 1835 | + /** |
|
| 1836 | + * @param int $ticket_row |
|
| 1837 | + * @param int $price_row |
|
| 1838 | + * @param EE_Price $price |
|
| 1839 | + * @param bool $default |
|
| 1840 | + * @param bool $disabled |
|
| 1841 | + * @return mixed |
|
| 1842 | + * @throws DomainException |
|
| 1843 | + * @throws EE_Error |
|
| 1844 | + */ |
|
| 1845 | + protected function _get_price_modifier_template( |
|
| 1846 | + $ticket_row, |
|
| 1847 | + $price_row, |
|
| 1848 | + $price, |
|
| 1849 | + $default, |
|
| 1850 | + $disabled = false |
|
| 1851 | + ) { |
|
| 1852 | + $select_name = $default && ! $price instanceof EE_Price |
|
| 1853 | + ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]' |
|
| 1854 | + : 'edit_prices[' . $ticket_row . '][' . $price_row . '][PRT_ID]'; |
|
| 1855 | + /** @var EEM_Price_Type $price_type_model */ |
|
| 1856 | + $price_type_model = EE_Registry::instance()->load_model('Price_Type'); |
|
| 1857 | + $price_types = $price_type_model->get_all(array( |
|
| 1858 | + array( |
|
| 1859 | + 'OR' => array( |
|
| 1860 | + 'PBT_ID' => '2', |
|
| 1861 | + 'PBT_ID*' => '3', |
|
| 1862 | + ), |
|
| 1863 | + ), |
|
| 1864 | + )); |
|
| 1865 | + $all_price_types = $default && ! $price instanceof EE_Price |
|
| 1866 | + ? array(esc_html__('Select Modifier', 'event_espresso')) |
|
| 1867 | + : array(); |
|
| 1868 | + $selected_price_type_id = $default && ! $price instanceof EE_Price ? 0 : $price->type(); |
|
| 1869 | + $price_option_spans = ''; |
|
| 1870 | + //setup price types for selector |
|
| 1871 | + foreach ($price_types as $price_type) { |
|
| 1872 | + if (! $price_type instanceof EE_Price_Type) { |
|
| 1873 | + continue; |
|
| 1874 | + } |
|
| 1875 | + $all_price_types[$price_type->ID()] = $price_type->get('PRT_name'); |
|
| 1876 | + //while we're in the loop let's setup the option spans used by js |
|
| 1877 | + $span_args = array( |
|
| 1878 | + 'PRT_ID' => $price_type->ID(), |
|
| 1879 | + 'PRT_operator' => $price_type->is_discount() ? '-' : '+', |
|
| 1880 | + 'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0, |
|
| 1881 | + ); |
|
| 1882 | + $price_option_spans .= EEH_Template::display_template( |
|
| 1883 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php', |
|
| 1884 | + $span_args, |
|
| 1885 | + true |
|
| 1886 | + ); |
|
| 1887 | + } |
|
| 1888 | + $select_name = $disabled ? 'archive_price[' . $ticket_row . '][' . $price_row . '][PRT_ID]' : $select_name; |
|
| 1889 | + $select_input = new EE_Select_Input( |
|
| 1890 | + $all_price_types, |
|
| 1891 | + array( |
|
| 1892 | + 'default' => $selected_price_type_id, |
|
| 1893 | + 'html_name' => $select_name, |
|
| 1894 | + 'html_class' => 'edit-price-PRT_ID', |
|
| 1895 | + 'html_other_attributes' => $disabled ? 'style="width:auto;" disabled' : 'style="width:auto;"', |
|
| 1896 | + ) |
|
| 1897 | + ); |
|
| 1898 | + $price_selected_operator = $price instanceof EE_Price && $price->is_discount() ? '-' : '+'; |
|
| 1899 | + $price_selected_operator = $default && ! $price instanceof EE_Price ? '' : $price_selected_operator; |
|
| 1900 | + $price_selected_is_percent = $price instanceof EE_Price && $price->is_percent() ? 1 : 0; |
|
| 1901 | + $price_selected_is_percent = $default && ! $price instanceof EE_Price ? '' : $price_selected_is_percent; |
|
| 1902 | + $template_args = array( |
|
| 1903 | + 'tkt_row' => $default ? 'TICKETNUM' : $ticket_row, |
|
| 1904 | + 'PRC_order' => $default && ! $price instanceof EE_Price ? 'PRICENUM' : $price_row, |
|
| 1905 | + 'price_modifier_selector' => $select_input->get_html_for_input(), |
|
| 1906 | + 'main_name' => $select_name, |
|
| 1907 | + 'selected_price_type_id' => $selected_price_type_id, |
|
| 1908 | + 'price_option_spans' => $price_option_spans, |
|
| 1909 | + 'price_selected_operator' => $price_selected_operator, |
|
| 1910 | + 'price_selected_is_percent' => $price_selected_is_percent, |
|
| 1911 | + 'disabled' => $disabled, |
|
| 1912 | + ); |
|
| 1913 | + $template_args = apply_filters( |
|
| 1914 | + 'FHEE__espresso_events_Pricing_Hooks___get_price_modifier_template__template_args', |
|
| 1915 | + $template_args, |
|
| 1916 | + $ticket_row, |
|
| 1917 | + $price_row, |
|
| 1918 | + $price, |
|
| 1919 | + $default, |
|
| 1920 | + $disabled, |
|
| 1921 | + $this->_is_creating_event |
|
| 1922 | + ); |
|
| 1923 | + return EEH_Template::display_template( |
|
| 1924 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php', |
|
| 1925 | + $template_args, |
|
| 1926 | + true |
|
| 1927 | + ); |
|
| 1928 | + } |
|
| 1929 | + |
|
| 1930 | + |
|
| 1931 | + |
|
| 1932 | + /** |
|
| 1933 | + * @param int $datetime_row |
|
| 1934 | + * @param int $ticket_row |
|
| 1935 | + * @param EE_Datetime|null $datetime |
|
| 1936 | + * @param EE_Ticket|null $ticket |
|
| 1937 | + * @param array $ticket_datetimes |
|
| 1938 | + * @param bool $default |
|
| 1939 | + * @return mixed |
|
| 1940 | + * @throws DomainException |
|
| 1941 | + * @throws EE_Error |
|
| 1942 | + */ |
|
| 1943 | + protected function _get_ticket_datetime_list_item( |
|
| 1944 | + $datetime_row, |
|
| 1945 | + $ticket_row, |
|
| 1946 | + $datetime, |
|
| 1947 | + $ticket, |
|
| 1948 | + $ticket_datetimes = array(), |
|
| 1949 | + $default |
|
| 1950 | + ) { |
|
| 1951 | + $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()]) |
|
| 1952 | + ? $ticket_datetimes[$ticket->ID()] |
|
| 1953 | + : array(); |
|
| 1954 | + $template_args = array( |
|
| 1955 | + 'dtt_row' => $default && ! $datetime instanceof EE_Datetime |
|
| 1956 | + ? 'DTTNUM' |
|
| 1957 | + : $datetime_row, |
|
| 1958 | + 'tkt_row' => $default |
|
| 1959 | + ? 'TICKETNUM' |
|
| 1960 | + : $ticket_row, |
|
| 1961 | + 'ticket_datetime_selected' => in_array($datetime_row, $tkt_datetimes, true) |
|
| 1962 | + ? ' ticket-selected' |
|
| 1963 | + : '', |
|
| 1964 | + 'ticket_datetime_checked' => in_array($datetime_row, $tkt_datetimes, true) |
|
| 1965 | + ? ' checked="checked"' |
|
| 1966 | + : '', |
|
| 1967 | + 'DTT_name' => $default && empty($datetime) |
|
| 1968 | + ? 'DTTNAME' |
|
| 1969 | + : $datetime->get_dtt_display_name(true), |
|
| 1970 | + 'tkt_status_class' => '', |
|
| 1971 | + ); |
|
| 1972 | + $template_args = apply_filters( |
|
| 1973 | + 'FHEE__espresso_events_Pricing_Hooks___get_ticket_datetime_list_item__template_args', |
|
| 1974 | + $template_args, |
|
| 1975 | + $datetime_row, |
|
| 1976 | + $ticket_row, |
|
| 1977 | + $datetime, |
|
| 1978 | + $ticket, |
|
| 1979 | + $ticket_datetimes, |
|
| 1980 | + $default, |
|
| 1981 | + $this->_is_creating_event |
|
| 1982 | + ); |
|
| 1983 | + return EEH_Template::display_template( |
|
| 1984 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php', |
|
| 1985 | + $template_args, |
|
| 1986 | + true |
|
| 1987 | + ); |
|
| 1988 | + } |
|
| 1989 | + |
|
| 1990 | + |
|
| 1991 | + |
|
| 1992 | + /** |
|
| 1993 | + * @param array $all_datetimes |
|
| 1994 | + * @param array $all_tickets |
|
| 1995 | + * @return mixed |
|
| 1996 | + * @throws DomainException |
|
| 1997 | + * @throws EE_Error |
|
| 1998 | + */ |
|
| 1999 | + protected function _get_ticket_js_structure($all_datetimes = array(), $all_tickets = array()) |
|
| 2000 | + { |
|
| 2001 | + $template_args = array( |
|
| 2002 | + 'default_datetime_edit_row' => $this->_get_dtt_edit_row( |
|
| 2003 | + 'DTTNUM', |
|
| 2004 | + null, |
|
| 2005 | + true, |
|
| 2006 | + $all_datetimes |
|
| 2007 | + ), |
|
| 2008 | + 'default_ticket_row' => $this->_get_ticket_row( |
|
| 2009 | + 'TICKETNUM', |
|
| 2010 | + null, |
|
| 2011 | + array(), |
|
| 2012 | + array(), |
|
| 2013 | + true |
|
| 2014 | + ), |
|
| 2015 | + 'default_price_row' => $this->_get_ticket_price_row( |
|
| 2016 | + 'TICKETNUM', |
|
| 2017 | + 'PRICENUM', |
|
| 2018 | + null, |
|
| 2019 | + true, |
|
| 2020 | + null |
|
| 2021 | + ), |
|
| 2022 | + 'default_price_rows' => '', |
|
| 2023 | + 'default_base_price_amount' => 0, |
|
| 2024 | + 'default_base_price_name' => '', |
|
| 2025 | + 'default_base_price_description' => '', |
|
| 2026 | + 'default_price_modifier_selector_row' => $this->_get_price_modifier_template( |
|
| 2027 | + 'TICKETNUM', |
|
| 2028 | + 'PRICENUM', |
|
| 2029 | + null, |
|
| 2030 | + true |
|
| 2031 | + ), |
|
| 2032 | + 'default_available_tickets_for_datetime' => $this->_get_dtt_attached_tickets_row( |
|
| 2033 | + 'DTTNUM', |
|
| 2034 | + null, |
|
| 2035 | + array(), |
|
| 2036 | + array(), |
|
| 2037 | + true |
|
| 2038 | + ), |
|
| 2039 | + 'existing_available_datetime_tickets_list' => '', |
|
| 2040 | + 'existing_available_ticket_datetimes_list' => '', |
|
| 2041 | + 'new_available_datetime_ticket_list_item' => $this->_get_datetime_tickets_list_item( |
|
| 2042 | + 'DTTNUM', |
|
| 2043 | + 'TICKETNUM', |
|
| 2044 | + null, |
|
| 2045 | + null, |
|
| 2046 | + array(), |
|
| 2047 | + true |
|
| 2048 | + ), |
|
| 2049 | + 'new_available_ticket_datetime_list_item' => $this->_get_ticket_datetime_list_item( |
|
| 2050 | + 'DTTNUM', |
|
| 2051 | + 'TICKETNUM', |
|
| 2052 | + null, |
|
| 2053 | + null, |
|
| 2054 | + array(), |
|
| 2055 | + true |
|
| 2056 | + ), |
|
| 2057 | + ); |
|
| 2058 | + $ticket_row = 1; |
|
| 2059 | + foreach ($all_tickets as $ticket) { |
|
| 2060 | + $template_args['existing_available_datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
|
| 2061 | + 'DTTNUM', |
|
| 2062 | + $ticket_row, |
|
| 2063 | + null, |
|
| 2064 | + $ticket, |
|
| 2065 | + array(), |
|
| 2066 | + true |
|
| 2067 | + ); |
|
| 2068 | + $ticket_row++; |
|
| 2069 | + } |
|
| 2070 | + $datetime_row = 1; |
|
| 2071 | + foreach ($all_datetimes as $datetime) { |
|
| 2072 | + $template_args['existing_available_ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
|
| 2073 | + $datetime_row, |
|
| 2074 | + 'TICKETNUM', |
|
| 2075 | + $datetime, |
|
| 2076 | + null, |
|
| 2077 | + array(), |
|
| 2078 | + true |
|
| 2079 | + ); |
|
| 2080 | + $datetime_row++; |
|
| 2081 | + } |
|
| 2082 | + /** @var EEM_Price $price_model */ |
|
| 2083 | + $price_model = EE_Registry::instance()->load_model('Price'); |
|
| 2084 | + $default_prices = $price_model->get_all_default_prices(); |
|
| 2085 | + $price_row = 1; |
|
| 2086 | + foreach ($default_prices as $price) { |
|
| 2087 | + if (! $price instanceof EE_Price) { |
|
| 2088 | + continue; |
|
| 2089 | + } |
|
| 2090 | + if ($price->is_base_price()) { |
|
| 2091 | + $template_args['default_base_price_amount'] = $price->get_pretty( |
|
| 2092 | + 'PRC_amount', |
|
| 2093 | + 'localized_float' |
|
| 2094 | + ); |
|
| 2095 | + $template_args['default_base_price_name'] = $price->get('PRC_name'); |
|
| 2096 | + $template_args['default_base_price_description'] = $price->get('PRC_desc'); |
|
| 2097 | + $price_row++; |
|
| 2098 | + continue; |
|
| 2099 | + } |
|
| 2100 | + $show_trash = !((count($default_prices) > 1 && $price_row === 1) || count($default_prices) === 1); |
|
| 2101 | + $show_create = !(count($default_prices) > 1 && count($default_prices) !== $price_row); |
|
| 2102 | + $template_args['default_price_rows'] .= $this->_get_ticket_price_row( |
|
| 2103 | + 'TICKETNUM', |
|
| 2104 | + $price_row, |
|
| 2105 | + $price, |
|
| 2106 | + true, |
|
| 2107 | + null, |
|
| 2108 | + $show_trash, |
|
| 2109 | + $show_create |
|
| 2110 | + ); |
|
| 2111 | + $price_row++; |
|
| 2112 | + } |
|
| 2113 | + $template_args = apply_filters( |
|
| 2114 | + 'FHEE__espresso_events_Pricing_Hooks___get_ticket_js_structure__template_args', |
|
| 2115 | + $template_args, |
|
| 2116 | + $all_datetimes, |
|
| 2117 | + $all_tickets, |
|
| 2118 | + $this->_is_creating_event |
|
| 2119 | + ); |
|
| 2120 | + return EEH_Template::display_template( |
|
| 2121 | + PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php', |
|
| 2122 | + $template_args, |
|
| 2123 | + true |
|
| 2124 | + ); |
|
| 2125 | + } |
|
| 2126 | 2126 | |
| 2127 | 2127 | |
| 2128 | 2128 | } //end class espresso_events_Pricing_Hooks |
@@ -49,7 +49,7 @@ discard block |
||
| 49 | 49 | { |
| 50 | 50 | $this->_name = 'pricing'; |
| 51 | 51 | //capability check |
| 52 | - if (! EE_Registry::instance()->CAP->current_user_can( |
|
| 52 | + if ( ! EE_Registry::instance()->CAP->current_user_can( |
|
| 53 | 53 | 'ee_read_default_prices', |
| 54 | 54 | 'advanced_ticket_datetime_metabox' |
| 55 | 55 | )) { |
@@ -125,7 +125,7 @@ discard block |
||
| 125 | 125 | $this->_date_format_strings['time'] = isset($this->_date_format_strings['time']) |
| 126 | 126 | ? $this->_date_format_strings['time'] |
| 127 | 127 | : null; |
| 128 | - $this->_date_time_format = $this->_date_format_strings['date'] . ' ' . $this->_date_format_strings['time']; |
|
| 128 | + $this->_date_time_format = $this->_date_format_strings['date'].' '.$this->_date_format_strings['time']; |
|
| 129 | 129 | } |
| 130 | 130 | |
| 131 | 131 | |
@@ -150,7 +150,7 @@ discard block |
||
| 150 | 150 | ); |
| 151 | 151 | $msg .= '</p><ul>'; |
| 152 | 152 | foreach ($format_validation as $error) { |
| 153 | - $msg .= '<li>' . $error . '</li>'; |
|
| 153 | + $msg .= '<li>'.$error.'</li>'; |
|
| 154 | 154 | } |
| 155 | 155 | $msg .= '</ul><p>'; |
| 156 | 156 | $msg .= sprintf( |
@@ -180,11 +180,11 @@ discard block |
||
| 180 | 180 | $this->_scripts_styles = array( |
| 181 | 181 | 'registers' => array( |
| 182 | 182 | 'ee-tickets-datetimes-css' => array( |
| 183 | - 'url' => PRICING_ASSETS_URL . 'event-tickets-datetimes.css', |
|
| 183 | + 'url' => PRICING_ASSETS_URL.'event-tickets-datetimes.css', |
|
| 184 | 184 | 'type' => 'css', |
| 185 | 185 | ), |
| 186 | 186 | 'ee-dtt-ticket-metabox' => array( |
| 187 | - 'url' => PRICING_ASSETS_URL . 'ee-datetime-ticket-metabox.js', |
|
| 187 | + 'url' => PRICING_ASSETS_URL.'ee-datetime-ticket-metabox.js', |
|
| 188 | 188 | 'depends' => array('ee-datepicker', 'ee-dialog', 'underscore'), |
| 189 | 189 | ), |
| 190 | 190 | ), |
@@ -208,9 +208,9 @@ discard block |
||
| 208 | 208 | 'event_espresso' |
| 209 | 209 | ), |
| 210 | 210 | 'cancel_button' => '<button class="button-secondary ee-modal-cancel">' |
| 211 | - . esc_html__('Cancel', 'event_espresso') . '</button>', |
|
| 211 | + . esc_html__('Cancel', 'event_espresso').'</button>', |
|
| 212 | 212 | 'close_button' => '<button class="button-secondary ee-modal-cancel">' |
| 213 | - . esc_html__('Close', 'event_espresso') . '</button>', |
|
| 213 | + . esc_html__('Close', 'event_espresso').'</button>', |
|
| 214 | 214 | 'single_warning_from_tkt' => esc_html__( |
| 215 | 215 | 'The Datetime you are attempting to unassign from this ticket is the only remaining datetime for this ticket. Tickets must always have at least one datetime assigned to them.', |
| 216 | 216 | 'event_espresso' |
@@ -220,12 +220,12 @@ discard block |
||
| 220 | 220 | 'event_espresso' |
| 221 | 221 | ), |
| 222 | 222 | 'dismiss_button' => '<button class="button-secondary ee-modal-cancel">' |
| 223 | - . esc_html__('Dismiss', 'event_espresso') . '</button>', |
|
| 223 | + . esc_html__('Dismiss', 'event_espresso').'</button>', |
|
| 224 | 224 | ), |
| 225 | 225 | 'DTT_ERROR_MSG' => array( |
| 226 | 226 | 'no_ticket_name' => esc_html__('General Admission', 'event_espresso'), |
| 227 | 227 | 'dismiss_button' => '<div class="save-cancel-button-container"><button class="button-secondary ee-modal-cancel">' |
| 228 | - . esc_html__('Dismiss', 'event_espresso') . '</button></div>', |
|
| 228 | + . esc_html__('Dismiss', 'event_espresso').'</button></div>', |
|
| 229 | 229 | ), |
| 230 | 230 | 'DTT_OVERSELL_WARNING' => array( |
| 231 | 231 | 'datetime_ticket' => esc_html__( |
@@ -241,7 +241,7 @@ discard block |
||
| 241 | 241 | $this->_date_format_strings['date'], |
| 242 | 242 | $this->_date_format_strings['time'] |
| 243 | 243 | ), |
| 244 | - 'DTT_START_OF_WEEK' => array('dayValue' => (int)get_option('start_of_week')), |
|
| 244 | + 'DTT_START_OF_WEEK' => array('dayValue' => (int) get_option('start_of_week')), |
|
| 245 | 245 | ), |
| 246 | 246 | ), |
| 247 | 247 | ); |
@@ -296,7 +296,7 @@ discard block |
||
| 296 | 296 | $timezone = isset($data['timezone_string']) ? $data['timezone_string'] : null; |
| 297 | 297 | $saved_dtt_ids = array(); |
| 298 | 298 | $saved_dtt_objs = array(); |
| 299 | - if (empty($data['edit_event_datetimes']) || !is_array($data['edit_event_datetimes'])) { |
|
| 299 | + if (empty($data['edit_event_datetimes']) || ! is_array($data['edit_event_datetimes'])) { |
|
| 300 | 300 | throw new InvalidArgumentException( |
| 301 | 301 | esc_html__( |
| 302 | 302 | 'The "edit_event_datetimes" array is invalid therefore the event can not be updated.', |
@@ -307,7 +307,7 @@ discard block |
||
| 307 | 307 | foreach ($data['edit_event_datetimes'] as $row => $datetime_data) { |
| 308 | 308 | //trim all values to ensure any excess whitespace is removed. |
| 309 | 309 | $datetime_data = array_map( |
| 310 | - function ($datetime_data) { |
|
| 310 | + function($datetime_data) { |
|
| 311 | 311 | return is_array($datetime_data) ? $datetime_data : trim($datetime_data); |
| 312 | 312 | }, |
| 313 | 313 | $datetime_data |
@@ -337,7 +337,7 @@ discard block |
||
| 337 | 337 | ); |
| 338 | 338 | // if we have an id then let's get existing object first and then set the new values. |
| 339 | 339 | // Otherwise we instantiate a new object for save. |
| 340 | - if (! empty($datetime_data['DTT_ID'])) { |
|
| 340 | + if ( ! empty($datetime_data['DTT_ID'])) { |
|
| 341 | 341 | $datetime = EE_Registry::instance() |
| 342 | 342 | ->load_model('Datetime', array($timezone)) |
| 343 | 343 | ->get_one_by_ID($datetime_data['DTT_ID']); |
@@ -430,7 +430,7 @@ discard block |
||
| 430 | 430 | $timezone = isset($data['timezone_string']) ? $data['timezone_string'] : null; |
| 431 | 431 | $saved_tickets = $datetimes_on_existing = array(); |
| 432 | 432 | $old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array(); |
| 433 | - if(empty($data['edit_tickets']) || ! is_array($data['edit_tickets'])){ |
|
| 433 | + if (empty($data['edit_tickets']) || ! is_array($data['edit_tickets'])) { |
|
| 434 | 434 | throw new InvalidArgumentException( |
| 435 | 435 | esc_html__( |
| 436 | 436 | 'The "edit_tickets" array is invalid therefore the event can not be updated.', |
@@ -448,7 +448,7 @@ discard block |
||
| 448 | 448 | $datetimes_removed = array_diff($starting_tkt_dtt_rows, $tkt_dtt_rows); |
| 449 | 449 | // trim inputs to ensure any excess whitespace is removed. |
| 450 | 450 | $tkt = array_map( |
| 451 | - function ($ticket_data) { |
|
| 451 | + function($ticket_data) { |
|
| 452 | 452 | return is_array($ticket_data) ? $ticket_data : trim($ticket_data); |
| 453 | 453 | }, |
| 454 | 454 | $tkt |
@@ -457,7 +457,7 @@ discard block |
||
| 457 | 457 | // because we're doing calculations prior to using the models. |
| 458 | 458 | // note incoming ['TKT_price'] value is already in standard notation (via js). |
| 459 | 459 | $ticket_price = isset($tkt['TKT_price']) |
| 460 | - ? round((float)$tkt['TKT_price'], 3) |
|
| 460 | + ? round((float) $tkt['TKT_price'], 3) |
|
| 461 | 461 | : 0; |
| 462 | 462 | //note incoming base price needs converted from localized value. |
| 463 | 463 | $base_price = isset($tkt['TKT_base_price']) |
@@ -604,7 +604,7 @@ discard block |
||
| 604 | 604 | //need to make sue that the TKT_price is accurate after saving the prices. |
| 605 | 605 | $ticket->ensure_TKT_Price_correct(); |
| 606 | 606 | //handle CREATING a default tkt from the incoming tkt but ONLY if this isn't an autosave. |
| 607 | - if (! defined('DOING_AUTOSAVE') && ! empty($tkt['TKT_is_default_selector'])) { |
|
| 607 | + if ( ! defined('DOING_AUTOSAVE') && ! empty($tkt['TKT_is_default_selector'])) { |
|
| 608 | 608 | $update_prices = true; |
| 609 | 609 | $new_default = clone $ticket; |
| 610 | 610 | $new_default->set('TKT_ID', 0); |
@@ -723,9 +723,9 @@ discard block |
||
| 723 | 723 | // to start we have to add the ticket to all the datetimes its supposed to be with, |
| 724 | 724 | // and removing the ticket from datetimes it got removed from. |
| 725 | 725 | // first let's add datetimes |
| 726 | - if (! empty($added_datetimes) && is_array($added_datetimes)) { |
|
| 726 | + if ( ! empty($added_datetimes) && is_array($added_datetimes)) { |
|
| 727 | 727 | foreach ($added_datetimes as $row_id) { |
| 728 | - $row_id = (int)$row_id; |
|
| 728 | + $row_id = (int) $row_id; |
|
| 729 | 729 | if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) { |
| 730 | 730 | $ticket->_add_relation_to($saved_datetimes[$row_id], 'Datetime'); |
| 731 | 731 | // Is this an existing ticket (has an ID) and does it have any sold? |
@@ -738,9 +738,9 @@ discard block |
||
| 738 | 738 | } |
| 739 | 739 | } |
| 740 | 740 | // then remove datetimes |
| 741 | - if (! empty($removed_datetimes) && is_array($removed_datetimes)) { |
|
| 741 | + if ( ! empty($removed_datetimes) && is_array($removed_datetimes)) { |
|
| 742 | 742 | foreach ($removed_datetimes as $row_id) { |
| 743 | - $row_id = (int)$row_id; |
|
| 743 | + $row_id = (int) $row_id; |
|
| 744 | 744 | // its entirely possible that a datetime got deleted (instead of just removed from relationship. |
| 745 | 745 | // So make sure we skip over this if the dtt isn't in the $saved_datetimes array) |
| 746 | 746 | if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) { |
@@ -850,7 +850,7 @@ discard block |
||
| 850 | 850 | ); |
| 851 | 851 | } |
| 852 | 852 | //possibly need to save tkt |
| 853 | - if (! $ticket->ID()) { |
|
| 853 | + if ( ! $ticket->ID()) { |
|
| 854 | 854 | $ticket->save(); |
| 855 | 855 | } |
| 856 | 856 | foreach ($prices as $row => $prc) { |
@@ -888,11 +888,11 @@ discard block |
||
| 888 | 888 | $ticket->_add_relation_to($price, 'Price'); |
| 889 | 889 | } |
| 890 | 890 | //now let's remove any prices that got removed from the ticket |
| 891 | - if (! empty ($current_prices_on_ticket)) { |
|
| 891 | + if ( ! empty ($current_prices_on_ticket)) { |
|
| 892 | 892 | $current = array_keys($current_prices_on_ticket); |
| 893 | 893 | $updated = array_keys($updated_prices); |
| 894 | 894 | $prices_to_remove = array_diff($current, $updated); |
| 895 | - if (! empty($prices_to_remove)) { |
|
| 895 | + if ( ! empty($prices_to_remove)) { |
|
| 896 | 896 | foreach ($prices_to_remove as $prc_id) { |
| 897 | 897 | $p = $current_prices_on_ticket[$prc_id]; |
| 898 | 898 | $ticket->_remove_relation_to($p, 'Price'); |
@@ -910,7 +910,7 @@ discard block |
||
| 910 | 910 | * @param Events_Admin_Page $event_admin_obj |
| 911 | 911 | * @return Events_Admin_Page |
| 912 | 912 | */ |
| 913 | - public function autosave_handling( Events_Admin_Page $event_admin_obj) |
|
| 913 | + public function autosave_handling(Events_Admin_Page $event_admin_obj) |
|
| 914 | 914 | { |
| 915 | 915 | return $event_admin_obj; |
| 916 | 916 | //doing nothing for the moment. |
@@ -1043,7 +1043,7 @@ discard block |
||
| 1043 | 1043 | $TKT_ID = $ticket->get('TKT_ID'); |
| 1044 | 1044 | $ticket_row = $ticket->get('TKT_row'); |
| 1045 | 1045 | //we only want unique tickets in our final display!! |
| 1046 | - if (! in_array($TKT_ID, $existing_ticket_ids, true)) { |
|
| 1046 | + if ( ! in_array($TKT_ID, $existing_ticket_ids, true)) { |
|
| 1047 | 1047 | $existing_ticket_ids[] = $TKT_ID; |
| 1048 | 1048 | $all_tickets[] = $ticket; |
| 1049 | 1049 | } |
@@ -1065,9 +1065,9 @@ discard block |
||
| 1065 | 1065 | //sort $all_tickets by order |
| 1066 | 1066 | usort( |
| 1067 | 1067 | $all_tickets, |
| 1068 | - function (EE_Ticket $a, EE_Ticket $b) { |
|
| 1069 | - $a_order = (int)$a->get('TKT_order'); |
|
| 1070 | - $b_order = (int)$b->get('TKT_order'); |
|
| 1068 | + function(EE_Ticket $a, EE_Ticket $b) { |
|
| 1069 | + $a_order = (int) $a->get('TKT_order'); |
|
| 1070 | + $b_order = (int) $b->get('TKT_order'); |
|
| 1071 | 1071 | if ($a_order === $b_order) { |
| 1072 | 1072 | return 0; |
| 1073 | 1073 | } |
@@ -1103,7 +1103,7 @@ discard block |
||
| 1103 | 1103 | } |
| 1104 | 1104 | $main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($datetimes, $all_tickets); |
| 1105 | 1105 | EEH_Template::display_template( |
| 1106 | - PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php', |
|
| 1106 | + PRICING_TEMPLATE_PATH.'event_tickets_metabox_main.template.php', |
|
| 1107 | 1107 | $main_template_args |
| 1108 | 1108 | ); |
| 1109 | 1109 | } |
@@ -1141,7 +1141,7 @@ discard block |
||
| 1141 | 1141 | 'dtt_row' => $default ? 'DTTNUM' : $datetime_row, |
| 1142 | 1142 | ); |
| 1143 | 1143 | return EEH_Template::display_template( |
| 1144 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php', |
|
| 1144 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_row_wrapper.template.php', |
|
| 1145 | 1145 | $dtt_display_template_args, |
| 1146 | 1146 | true |
| 1147 | 1147 | ); |
@@ -1211,7 +1211,7 @@ discard block |
||
| 1211 | 1211 | $this->_is_creating_event |
| 1212 | 1212 | ); |
| 1213 | 1213 | return EEH_Template::display_template( |
| 1214 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php', |
|
| 1214 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_edit_row.template.php', |
|
| 1215 | 1215 | $template_args, |
| 1216 | 1216 | true |
| 1217 | 1217 | ); |
@@ -1253,7 +1253,7 @@ discard block |
||
| 1253 | 1253 | 'DTT_ID' => $default ? '' : $datetime->ID(), |
| 1254 | 1254 | ); |
| 1255 | 1255 | //need to setup the list items (but only if this isn't a default skeleton setup) |
| 1256 | - if (! $default) { |
|
| 1256 | + if ( ! $default) { |
|
| 1257 | 1257 | $ticket_row = 1; |
| 1258 | 1258 | foreach ($all_tickets as $ticket) { |
| 1259 | 1259 | $template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item( |
@@ -1279,7 +1279,7 @@ discard block |
||
| 1279 | 1279 | $this->_is_creating_event |
| 1280 | 1280 | ); |
| 1281 | 1281 | return EEH_Template::display_template( |
| 1282 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php', |
|
| 1282 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_attached_tickets_row.template.php', |
|
| 1283 | 1283 | $template_args, |
| 1284 | 1284 | true |
| 1285 | 1285 | ); |
@@ -1328,8 +1328,8 @@ discard block |
||
| 1328 | 1328 | ? 'TKTNAME' |
| 1329 | 1329 | : $ticket->get('TKT_name'), |
| 1330 | 1330 | 'tkt_status_class' => $no_ticket || $this->_is_creating_event |
| 1331 | - ? ' tkt-status-' . EE_Ticket::onsale |
|
| 1332 | - : ' tkt-status-' . $ticket->ticket_status(), |
|
| 1331 | + ? ' tkt-status-'.EE_Ticket::onsale |
|
| 1332 | + : ' tkt-status-'.$ticket->ticket_status(), |
|
| 1333 | 1333 | ); |
| 1334 | 1334 | //filter template args |
| 1335 | 1335 | $template_args = apply_filters( |
@@ -1344,7 +1344,7 @@ discard block |
||
| 1344 | 1344 | $this->_is_creating_event |
| 1345 | 1345 | ); |
| 1346 | 1346 | return EEH_Template::display_template( |
| 1347 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php', |
|
| 1347 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_dtt_tickets_list.template.php', |
|
| 1348 | 1348 | $template_args, |
| 1349 | 1349 | true |
| 1350 | 1350 | ); |
@@ -1401,11 +1401,11 @@ discard block |
||
| 1401 | 1401 | $count_price_mods = EEM_Price::instance()->get_all_default_prices(true); |
| 1402 | 1402 | //breaking out complicated condition for ticket_status |
| 1403 | 1403 | if ($default) { |
| 1404 | - $ticket_status_class = ' tkt-status-' . EE_Ticket::onsale; |
|
| 1404 | + $ticket_status_class = ' tkt-status-'.EE_Ticket::onsale; |
|
| 1405 | 1405 | } else { |
| 1406 | 1406 | $ticket_status_class = $ticket->is_default() |
| 1407 | - ? ' tkt-status-' . EE_Ticket::onsale |
|
| 1408 | - : ' tkt-status-' . $ticket->ticket_status(); |
|
| 1407 | + ? ' tkt-status-'.EE_Ticket::onsale |
|
| 1408 | + : ' tkt-status-'.$ticket->ticket_status(); |
|
| 1409 | 1409 | } |
| 1410 | 1410 | //breaking out complicated condition for TKT_taxable |
| 1411 | 1411 | if ($default) { |
@@ -1497,7 +1497,7 @@ discard block |
||
| 1497 | 1497 | : ' style="display:none;"', |
| 1498 | 1498 | 'show_price_mod_button' => count($prices) > 1 |
| 1499 | 1499 | || ($default && $count_price_mods > 0) |
| 1500 | - || (! $default && $ticket->deleted()) |
|
| 1500 | + || ( ! $default && $ticket->deleted()) |
|
| 1501 | 1501 | ? ' style="display:none;"' |
| 1502 | 1502 | : '', |
| 1503 | 1503 | 'total_price_rows' => count($prices) > 1 ? count($prices) : 1, |
@@ -1539,7 +1539,7 @@ discard block |
||
| 1539 | 1539 | //if empty then the start date will be now. |
| 1540 | 1540 | $template_args['TKT_start_date'] = date($this->_date_time_format, |
| 1541 | 1541 | current_time('timestamp')); |
| 1542 | - $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
| 1542 | + $template_args['tkt_status_class'] = ' tkt-status-'.EE_Ticket::onsale; |
|
| 1543 | 1543 | } |
| 1544 | 1544 | if (empty($template_args['TKT_end_date'])) { |
| 1545 | 1545 | //get the earliest datetime (if present); |
@@ -1549,7 +1549,7 @@ discard block |
||
| 1549 | 1549 | array('order_by' => array('DTT_EVT_start' => 'ASC')) |
| 1550 | 1550 | ) |
| 1551 | 1551 | : null; |
| 1552 | - if (! empty($earliest_dtt)) { |
|
| 1552 | + if ( ! empty($earliest_dtt)) { |
|
| 1553 | 1553 | $template_args['TKT_end_date'] = $earliest_dtt->get_datetime( |
| 1554 | 1554 | 'DTT_EVT_start', |
| 1555 | 1555 | $this->_date_time_format |
@@ -1562,10 +1562,10 @@ discard block |
||
| 1562 | 1562 | ) |
| 1563 | 1563 | ); |
| 1564 | 1564 | } |
| 1565 | - $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale; |
|
| 1565 | + $template_args['tkt_status_class'] = ' tkt-status-'.EE_Ticket::onsale; |
|
| 1566 | 1566 | } |
| 1567 | 1567 | //generate ticket_datetime items |
| 1568 | - if (! $default) { |
|
| 1568 | + if ( ! $default) { |
|
| 1569 | 1569 | $datetime_row = 1; |
| 1570 | 1570 | foreach ($all_datetimes as $datetime) { |
| 1571 | 1571 | $template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item( |
@@ -1581,15 +1581,15 @@ discard block |
||
| 1581 | 1581 | } |
| 1582 | 1582 | $price_row = 1; |
| 1583 | 1583 | foreach ($prices as $price) { |
| 1584 | - if (! $price instanceof EE_Price) { |
|
| 1584 | + if ( ! $price instanceof EE_Price) { |
|
| 1585 | 1585 | continue; |
| 1586 | 1586 | } |
| 1587 | 1587 | if ($price->is_base_price()) { |
| 1588 | 1588 | $price_row++; |
| 1589 | 1589 | continue; |
| 1590 | 1590 | } |
| 1591 | - $show_trash = !((count($prices) > 1 && $price_row === 1) || count($prices) === 1); |
|
| 1592 | - $show_create = !(count($prices) > 1 && count($prices) !== $price_row); |
|
| 1591 | + $show_trash = ! ((count($prices) > 1 && $price_row === 1) || count($prices) === 1); |
|
| 1592 | + $show_create = ! (count($prices) > 1 && count($prices) !== $price_row); |
|
| 1593 | 1593 | $template_args['ticket_price_rows'] .= $this->_get_ticket_price_row( |
| 1594 | 1594 | $ticket_row, |
| 1595 | 1595 | $price_row, |
@@ -1614,7 +1614,7 @@ discard block |
||
| 1614 | 1614 | $this->_is_creating_event |
| 1615 | 1615 | ); |
| 1616 | 1616 | return EEH_Template::display_template( |
| 1617 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php', |
|
| 1617 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_row.template.php', |
|
| 1618 | 1618 | $template_args, |
| 1619 | 1619 | true |
| 1620 | 1620 | ); |
@@ -1655,7 +1655,7 @@ discard block |
||
| 1655 | 1655 | $this->_is_creating_event |
| 1656 | 1656 | ); |
| 1657 | 1657 | $tax_rows .= EEH_Template::display_template( |
| 1658 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php', |
|
| 1658 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_tax_row.template.php', |
|
| 1659 | 1659 | $template_args, |
| 1660 | 1660 | true |
| 1661 | 1661 | ); |
@@ -1767,7 +1767,7 @@ discard block |
||
| 1767 | 1767 | $this->_is_creating_event |
| 1768 | 1768 | ); |
| 1769 | 1769 | return EEH_Template::display_template( |
| 1770 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php', |
|
| 1770 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_price_row.template.php', |
|
| 1771 | 1771 | $template_args, |
| 1772 | 1772 | true |
| 1773 | 1773 | ); |
@@ -1824,7 +1824,7 @@ discard block |
||
| 1824 | 1824 | $this->_is_creating_event |
| 1825 | 1825 | ); |
| 1826 | 1826 | return EEH_Template::display_template( |
| 1827 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php', |
|
| 1827 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_type_base.template.php', |
|
| 1828 | 1828 | $template_args, |
| 1829 | 1829 | true |
| 1830 | 1830 | ); |
@@ -1851,7 +1851,7 @@ discard block |
||
| 1851 | 1851 | ) { |
| 1852 | 1852 | $select_name = $default && ! $price instanceof EE_Price |
| 1853 | 1853 | ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]' |
| 1854 | - : 'edit_prices[' . $ticket_row . '][' . $price_row . '][PRT_ID]'; |
|
| 1854 | + : 'edit_prices['.$ticket_row.']['.$price_row.'][PRT_ID]'; |
|
| 1855 | 1855 | /** @var EEM_Price_Type $price_type_model */ |
| 1856 | 1856 | $price_type_model = EE_Registry::instance()->load_model('Price_Type'); |
| 1857 | 1857 | $price_types = $price_type_model->get_all(array( |
@@ -1869,7 +1869,7 @@ discard block |
||
| 1869 | 1869 | $price_option_spans = ''; |
| 1870 | 1870 | //setup price types for selector |
| 1871 | 1871 | foreach ($price_types as $price_type) { |
| 1872 | - if (! $price_type instanceof EE_Price_Type) { |
|
| 1872 | + if ( ! $price_type instanceof EE_Price_Type) { |
|
| 1873 | 1873 | continue; |
| 1874 | 1874 | } |
| 1875 | 1875 | $all_price_types[$price_type->ID()] = $price_type->get('PRT_name'); |
@@ -1880,12 +1880,12 @@ discard block |
||
| 1880 | 1880 | 'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0, |
| 1881 | 1881 | ); |
| 1882 | 1882 | $price_option_spans .= EEH_Template::display_template( |
| 1883 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php', |
|
| 1883 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_option_span.template.php', |
|
| 1884 | 1884 | $span_args, |
| 1885 | 1885 | true |
| 1886 | 1886 | ); |
| 1887 | 1887 | } |
| 1888 | - $select_name = $disabled ? 'archive_price[' . $ticket_row . '][' . $price_row . '][PRT_ID]' : $select_name; |
|
| 1888 | + $select_name = $disabled ? 'archive_price['.$ticket_row.']['.$price_row.'][PRT_ID]' : $select_name; |
|
| 1889 | 1889 | $select_input = new EE_Select_Input( |
| 1890 | 1890 | $all_price_types, |
| 1891 | 1891 | array( |
@@ -1921,7 +1921,7 @@ discard block |
||
| 1921 | 1921 | $this->_is_creating_event |
| 1922 | 1922 | ); |
| 1923 | 1923 | return EEH_Template::display_template( |
| 1924 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php', |
|
| 1924 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_modifier_selector.template.php', |
|
| 1925 | 1925 | $template_args, |
| 1926 | 1926 | true |
| 1927 | 1927 | ); |
@@ -1981,7 +1981,7 @@ discard block |
||
| 1981 | 1981 | $this->_is_creating_event |
| 1982 | 1982 | ); |
| 1983 | 1983 | return EEH_Template::display_template( |
| 1984 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php', |
|
| 1984 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_datetimes_list_item.template.php', |
|
| 1985 | 1985 | $template_args, |
| 1986 | 1986 | true |
| 1987 | 1987 | ); |
@@ -2084,7 +2084,7 @@ discard block |
||
| 2084 | 2084 | $default_prices = $price_model->get_all_default_prices(); |
| 2085 | 2085 | $price_row = 1; |
| 2086 | 2086 | foreach ($default_prices as $price) { |
| 2087 | - if (! $price instanceof EE_Price) { |
|
| 2087 | + if ( ! $price instanceof EE_Price) { |
|
| 2088 | 2088 | continue; |
| 2089 | 2089 | } |
| 2090 | 2090 | if ($price->is_base_price()) { |
@@ -2097,8 +2097,8 @@ discard block |
||
| 2097 | 2097 | $price_row++; |
| 2098 | 2098 | continue; |
| 2099 | 2099 | } |
| 2100 | - $show_trash = !((count($default_prices) > 1 && $price_row === 1) || count($default_prices) === 1); |
|
| 2101 | - $show_create = !(count($default_prices) > 1 && count($default_prices) !== $price_row); |
|
| 2100 | + $show_trash = ! ((count($default_prices) > 1 && $price_row === 1) || count($default_prices) === 1); |
|
| 2101 | + $show_create = ! (count($default_prices) > 1 && count($default_prices) !== $price_row); |
|
| 2102 | 2102 | $template_args['default_price_rows'] .= $this->_get_ticket_price_row( |
| 2103 | 2103 | 'TICKETNUM', |
| 2104 | 2104 | $price_row, |
@@ -2118,7 +2118,7 @@ discard block |
||
| 2118 | 2118 | $this->_is_creating_event |
| 2119 | 2119 | ); |
| 2120 | 2120 | return EEH_Template::display_template( |
| 2121 | - PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php', |
|
| 2121 | + PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_js_structure.template.php', |
|
| 2122 | 2122 | $template_args, |
| 2123 | 2123 | true |
| 2124 | 2124 | ); |
@@ -456,7 +456,7 @@ |
||
| 456 | 456 | * be empty |
| 457 | 457 | * |
| 458 | 458 | * @since 4.3.1 |
| 459 | - * @return array |
|
| 459 | + * @return string[] |
|
| 460 | 460 | */ |
| 461 | 461 | private function _parse_from() |
| 462 | 462 | { |
@@ -1,7 +1,7 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | |
| 3 | 3 | if (! defined('EVENT_ESPRESSO_VERSION')) { |
| 4 | - exit('NO direct script access allowed'); |
|
| 4 | + exit('NO direct script access allowed'); |
|
| 5 | 5 | } |
| 6 | 6 | |
| 7 | 7 | /** |
@@ -28,548 +28,548 @@ discard block |
||
| 28 | 28 | class EE_Email_messenger extends EE_messenger |
| 29 | 29 | { |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * The following are the properties that email requires for the message going out. |
|
| 33 | - */ |
|
| 34 | - protected $_to; |
|
| 35 | - protected $_from; |
|
| 36 | - protected $_subject; |
|
| 37 | - protected $_content; |
|
| 38 | - |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * constructor |
|
| 42 | - * |
|
| 43 | - * @access public |
|
| 44 | - */ |
|
| 45 | - public function __construct() |
|
| 46 | - { |
|
| 47 | - //set name and description properties |
|
| 48 | - $this->name = 'email'; |
|
| 49 | - $this->description = __('This messenger delivers messages via email using the built-in <code>wp_mail</code> function included with WordPress', |
|
| 50 | - 'event_espresso'); |
|
| 51 | - $this->label = array( |
|
| 52 | - 'singular' => __('email', 'event_espresso'), |
|
| 53 | - 'plural' => __('emails', 'event_espresso'), |
|
| 54 | - ); |
|
| 55 | - $this->activate_on_install = true; |
|
| 56 | - |
|
| 57 | - //we're using defaults so let's call parent constructor that will take care of setting up all the other properties |
|
| 58 | - parent::__construct(); |
|
| 59 | - } |
|
| 60 | - |
|
| 61 | - |
|
| 62 | - /** |
|
| 63 | - * see abstract declaration in parent class for details. |
|
| 64 | - */ |
|
| 65 | - protected function _set_admin_pages() |
|
| 66 | - { |
|
| 67 | - $this->admin_registered_pages = array( |
|
| 68 | - 'events_edit' => true, |
|
| 69 | - ); |
|
| 70 | - } |
|
| 71 | - |
|
| 72 | - |
|
| 73 | - /** |
|
| 74 | - * see abstract declaration in parent class for details |
|
| 75 | - */ |
|
| 76 | - protected function _set_valid_shortcodes() |
|
| 77 | - { |
|
| 78 | - //remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the message type. |
|
| 79 | - $this->_valid_shortcodes = array( |
|
| 80 | - 'to' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'), |
|
| 81 | - 'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'), |
|
| 82 | - ); |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - |
|
| 86 | - /** |
|
| 87 | - * see abstract declaration in parent class for details |
|
| 88 | - * |
|
| 89 | - * @access protected |
|
| 90 | - * @return void |
|
| 91 | - */ |
|
| 92 | - protected function _set_validator_config() |
|
| 93 | - { |
|
| 94 | - $valid_shortcodes = $this->get_valid_shortcodes(); |
|
| 95 | - |
|
| 96 | - $this->_validator_config = array( |
|
| 97 | - 'to' => array( |
|
| 98 | - 'shortcodes' => $valid_shortcodes['to'], |
|
| 99 | - 'type' => 'email', |
|
| 100 | - ), |
|
| 101 | - 'from' => array( |
|
| 102 | - 'shortcodes' => $valid_shortcodes['from'], |
|
| 103 | - 'type' => 'email', |
|
| 104 | - ), |
|
| 105 | - 'subject' => array( |
|
| 106 | - 'shortcodes' => array( |
|
| 107 | - 'organization', |
|
| 108 | - 'primary_registration_details', |
|
| 109 | - 'event_author', |
|
| 110 | - 'primary_registration_details', |
|
| 111 | - 'recipient_details', |
|
| 112 | - ), |
|
| 113 | - ), |
|
| 114 | - 'content' => array( |
|
| 115 | - 'shortcodes' => array( |
|
| 116 | - 'event_list', |
|
| 117 | - 'attendee_list', |
|
| 118 | - 'ticket_list', |
|
| 119 | - 'organization', |
|
| 120 | - 'primary_registration_details', |
|
| 121 | - 'primary_registration_list', |
|
| 122 | - 'event_author', |
|
| 123 | - 'recipient_details', |
|
| 124 | - 'recipient_list', |
|
| 125 | - 'transaction', |
|
| 126 | - 'messenger', |
|
| 127 | - ), |
|
| 128 | - ), |
|
| 129 | - 'attendee_list' => array( |
|
| 130 | - 'shortcodes' => array('attendee', 'event_list', 'ticket_list'), |
|
| 131 | - 'required' => array('[ATTENDEE_LIST]'), |
|
| 132 | - ), |
|
| 133 | - 'event_list' => array( |
|
| 134 | - 'shortcodes' => array( |
|
| 135 | - 'event', |
|
| 136 | - 'attendee_list', |
|
| 137 | - 'ticket_list', |
|
| 138 | - 'venue', |
|
| 139 | - 'datetime_list', |
|
| 140 | - 'attendee', |
|
| 141 | - 'primary_registration_details', |
|
| 142 | - 'primary_registration_list', |
|
| 143 | - 'event_author', |
|
| 144 | - 'recipient_details', |
|
| 145 | - 'recipient_list', |
|
| 146 | - ), |
|
| 147 | - 'required' => array('[EVENT_LIST]'), |
|
| 148 | - ), |
|
| 149 | - 'ticket_list' => array( |
|
| 150 | - 'shortcodes' => array( |
|
| 151 | - 'event_list', |
|
| 152 | - 'attendee_list', |
|
| 153 | - 'ticket', |
|
| 154 | - 'datetime_list', |
|
| 155 | - 'primary_registration_details', |
|
| 156 | - 'recipient_details', |
|
| 157 | - ), |
|
| 158 | - 'required' => array('[TICKET_LIST]'), |
|
| 159 | - ), |
|
| 160 | - 'datetime_list' => array( |
|
| 161 | - 'shortcodes' => array('datetime'), |
|
| 162 | - 'required' => array('[DATETIME_LIST]'), |
|
| 163 | - ), |
|
| 164 | - ); |
|
| 165 | - } |
|
| 166 | - |
|
| 167 | - |
|
| 168 | - /** |
|
| 169 | - * @see parent EE_messenger class for docs |
|
| 170 | - * @since 4.5.0 |
|
| 171 | - */ |
|
| 172 | - public function do_secondary_messenger_hooks($sending_messenger_name) |
|
| 173 | - { |
|
| 174 | - if ($sending_messenger_name = 'html') { |
|
| 175 | - add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8); |
|
| 176 | - } |
|
| 177 | - } |
|
| 178 | - |
|
| 179 | - |
|
| 180 | - public function add_email_css( |
|
| 181 | - $variation_path, |
|
| 182 | - $messenger, |
|
| 183 | - $message_type, |
|
| 184 | - $type, |
|
| 185 | - $variation, |
|
| 186 | - $file_extension, |
|
| 187 | - $url, |
|
| 188 | - EE_Messages_Template_Pack $template_pack |
|
| 189 | - ) { |
|
| 190 | - //prevent recursion on this callback. |
|
| 191 | - remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10); |
|
| 192 | - $variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false); |
|
| 193 | - |
|
| 194 | - add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8); |
|
| 195 | - return $variation; |
|
| 196 | - } |
|
| 197 | - |
|
| 198 | - |
|
| 199 | - /** |
|
| 200 | - * See parent for details |
|
| 201 | - * |
|
| 202 | - * @access protected |
|
| 203 | - * @return void |
|
| 204 | - */ |
|
| 205 | - protected function _set_test_settings_fields() |
|
| 206 | - { |
|
| 207 | - $this->_test_settings_fields = array( |
|
| 208 | - 'to' => array( |
|
| 209 | - 'input' => 'text', |
|
| 210 | - 'label' => __('Send a test email to', 'event_espresso'), |
|
| 211 | - 'type' => 'email', |
|
| 212 | - 'required' => true, |
|
| 213 | - 'validation' => true, |
|
| 214 | - 'css_class' => 'large-text', |
|
| 215 | - 'format' => '%s', |
|
| 216 | - 'default' => get_bloginfo('admin_email'), |
|
| 217 | - ), |
|
| 218 | - 'subject' => array( |
|
| 219 | - 'input' => 'hidden', |
|
| 220 | - 'label' => '', |
|
| 221 | - 'type' => 'string', |
|
| 222 | - 'required' => false, |
|
| 223 | - 'validation' => false, |
|
| 224 | - 'format' => '%s', |
|
| 225 | - 'value' => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')), |
|
| 226 | - 'default' => '', |
|
| 227 | - 'css_class' => '', |
|
| 228 | - ), |
|
| 229 | - ); |
|
| 230 | - } |
|
| 231 | - |
|
| 232 | - |
|
| 233 | - /** |
|
| 234 | - * _set_template_fields |
|
| 235 | - * This sets up the fields that a messenger requires for the message to go out. |
|
| 236 | - * |
|
| 237 | - * @access protected |
|
| 238 | - * @return void |
|
| 239 | - */ |
|
| 240 | - protected function _set_template_fields() |
|
| 241 | - { |
|
| 242 | - // any extra template fields that are NOT used by the messenger but will get used by a messenger field for shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field they relate to. This is important for the Messages_admin to know what fields to display to the user. Also, notice that the "values" are equal to the field type that messages admin will use to know what kind of field to display. The values ALSO have one index labeled "shortcode". the values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be displayed. If the required shortcode isn't part of the shortcodes array then the field is not needed and will not be displayed/parsed. |
|
| 243 | - $this->_template_fields = array( |
|
| 244 | - 'to' => array( |
|
| 245 | - 'input' => 'text', |
|
| 246 | - 'label' => __('To', 'event_espresso'), |
|
| 247 | - 'type' => 'string', |
|
| 248 | - 'required' => true, |
|
| 249 | - 'validation' => true, |
|
| 250 | - 'css_class' => 'large-text', |
|
| 251 | - 'format' => '%s', |
|
| 252 | - ), |
|
| 253 | - 'from' => array( |
|
| 254 | - 'input' => 'text', |
|
| 255 | - 'label' => __('From', 'event_espresso'), |
|
| 256 | - 'type' => 'string', |
|
| 257 | - 'required' => true, |
|
| 258 | - 'validation' => true, |
|
| 259 | - 'css_class' => 'large-text', |
|
| 260 | - 'format' => '%s', |
|
| 261 | - ), |
|
| 262 | - 'subject' => array( |
|
| 263 | - 'input' => 'text', |
|
| 264 | - 'label' => __('Subject', 'event_espresso'), |
|
| 265 | - 'type' => 'string', |
|
| 266 | - 'required' => true, |
|
| 267 | - 'validation' => true, |
|
| 268 | - 'css_class' => 'large-text', |
|
| 269 | - 'format' => '%s', |
|
| 270 | - ), |
|
| 271 | - 'content' => '', |
|
| 272 | - //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field. |
|
| 273 | - 'extra' => array( |
|
| 274 | - 'content' => array( |
|
| 275 | - 'main' => array( |
|
| 276 | - 'input' => 'wp_editor', |
|
| 277 | - 'label' => __('Main Content', 'event_espresso'), |
|
| 278 | - 'type' => 'string', |
|
| 279 | - 'required' => true, |
|
| 280 | - 'validation' => true, |
|
| 281 | - 'format' => '%s', |
|
| 282 | - 'rows' => '15', |
|
| 283 | - ), |
|
| 284 | - 'event_list' => array( |
|
| 285 | - 'input' => 'wp_editor', |
|
| 286 | - 'label' => '[EVENT_LIST]', |
|
| 287 | - 'type' => 'string', |
|
| 288 | - 'required' => true, |
|
| 289 | - 'validation' => true, |
|
| 290 | - 'format' => '%s', |
|
| 291 | - 'rows' => '15', |
|
| 292 | - 'shortcodes_required' => array('[EVENT_LIST]'), |
|
| 293 | - ), |
|
| 294 | - 'attendee_list' => array( |
|
| 295 | - 'input' => 'textarea', |
|
| 296 | - 'label' => '[ATTENDEE_LIST]', |
|
| 297 | - 'type' => 'string', |
|
| 298 | - 'required' => true, |
|
| 299 | - 'validation' => true, |
|
| 300 | - 'format' => '%s', |
|
| 301 | - 'css_class' => 'large-text', |
|
| 302 | - 'rows' => '5', |
|
| 303 | - 'shortcodes_required' => array('[ATTENDEE_LIST]'), |
|
| 304 | - ), |
|
| 305 | - 'ticket_list' => array( |
|
| 306 | - 'input' => 'textarea', |
|
| 307 | - 'label' => '[TICKET_LIST]', |
|
| 308 | - 'type' => 'string', |
|
| 309 | - 'required' => true, |
|
| 310 | - 'validation' => true, |
|
| 311 | - 'format' => '%s', |
|
| 312 | - 'css_class' => 'large-text', |
|
| 313 | - 'rows' => '10', |
|
| 314 | - 'shortcodes_required' => array('[TICKET_LIST]'), |
|
| 315 | - ), |
|
| 316 | - 'datetime_list' => array( |
|
| 317 | - 'input' => 'textarea', |
|
| 318 | - 'label' => '[DATETIME_LIST]', |
|
| 319 | - 'type' => 'string', |
|
| 320 | - 'required' => true, |
|
| 321 | - 'validation' => true, |
|
| 322 | - 'format' => '%s', |
|
| 323 | - 'css_class' => 'large-text', |
|
| 324 | - 'rows' => '10', |
|
| 325 | - 'shortcodes_required' => array('[DATETIME_LIST]'), |
|
| 326 | - ), |
|
| 327 | - ), |
|
| 328 | - ), |
|
| 329 | - ); |
|
| 330 | - } |
|
| 331 | - |
|
| 332 | - |
|
| 333 | - /** |
|
| 334 | - * See definition of this class in parent |
|
| 335 | - */ |
|
| 336 | - protected function _set_default_message_types() |
|
| 337 | - { |
|
| 338 | - $this->_default_message_types = array( |
|
| 339 | - 'payment', |
|
| 340 | - 'payment_refund', |
|
| 341 | - 'registration', |
|
| 342 | - 'not_approved_registration', |
|
| 343 | - 'pending_approval', |
|
| 344 | - ); |
|
| 345 | - } |
|
| 346 | - |
|
| 347 | - |
|
| 348 | - /** |
|
| 349 | - * @see definition of this class in parent |
|
| 350 | - * @since 4.5.0 |
|
| 351 | - */ |
|
| 352 | - protected function _set_valid_message_types() |
|
| 353 | - { |
|
| 354 | - $this->_valid_message_types = array( |
|
| 355 | - 'payment', |
|
| 356 | - 'registration', |
|
| 357 | - 'not_approved_registration', |
|
| 358 | - 'declined_registration', |
|
| 359 | - 'cancelled_registration', |
|
| 360 | - 'pending_approval', |
|
| 361 | - 'registration_summary', |
|
| 362 | - 'payment_reminder', |
|
| 363 | - 'payment_declined', |
|
| 364 | - 'payment_refund', |
|
| 365 | - ); |
|
| 366 | - } |
|
| 367 | - |
|
| 368 | - |
|
| 369 | - /** |
|
| 370 | - * setting up admin_settings_fields for messenger. |
|
| 371 | - */ |
|
| 372 | - protected function _set_admin_settings_fields() |
|
| 373 | - { |
|
| 374 | - } |
|
| 375 | - |
|
| 376 | - /** |
|
| 377 | - * We just deliver the messages don't kill us!! |
|
| 378 | - * |
|
| 379 | - * @return bool | WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if |
|
| 380 | - * present. |
|
| 381 | - */ |
|
| 382 | - protected function _send_message() |
|
| 383 | - { |
|
| 384 | - $success = wp_mail( |
|
| 385 | - html_entity_decode($this->_to, ENT_QUOTES, "UTF-8"), |
|
| 386 | - stripslashes(html_entity_decode($this->_subject, ENT_QUOTES, "UTF-8")), |
|
| 387 | - $this->_body(), |
|
| 388 | - $this->_headers() |
|
| 389 | - ); |
|
| 390 | - if (! $success) { |
|
| 391 | - EE_Error::add_error( |
|
| 392 | - sprintf( |
|
| 393 | - __('The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s', |
|
| 394 | - 'event_espresso'), |
|
| 395 | - $this->_to, |
|
| 396 | - $this->_from, |
|
| 397 | - '<br />' |
|
| 398 | - ), |
|
| 399 | - __FILE__, __FUNCTION__, __LINE__ |
|
| 400 | - ); |
|
| 401 | - } |
|
| 402 | - return $success; |
|
| 403 | - } |
|
| 404 | - |
|
| 405 | - |
|
| 406 | - /** |
|
| 407 | - * see parent for definition |
|
| 408 | - * |
|
| 409 | - * @return string html body of the message content and the related css. |
|
| 410 | - */ |
|
| 411 | - protected function _preview() |
|
| 412 | - { |
|
| 413 | - return $this->_body(true); |
|
| 414 | - } |
|
| 415 | - |
|
| 416 | - |
|
| 417 | - /** |
|
| 418 | - * Setup headers for email |
|
| 419 | - * |
|
| 420 | - * @access protected |
|
| 421 | - * @return string formatted header for email |
|
| 422 | - */ |
|
| 423 | - protected function _headers() |
|
| 424 | - { |
|
| 425 | - $this->_ensure_has_from_email_address(); |
|
| 426 | - $from = stripslashes_deep(html_entity_decode($this->_from, ENT_QUOTES, "UTF-8")); |
|
| 427 | - $headers = array( |
|
| 428 | - 'MIME-Version: 1.0', |
|
| 429 | - 'From:' . $from, |
|
| 430 | - 'Reply-To:' . $from, |
|
| 431 | - 'Content-Type:text/html; charset=utf-8', |
|
| 432 | - ); |
|
| 433 | - |
|
| 434 | - //but wait! Header's for the from is NOT reliable because some plugins don't respect From: as set in the header. |
|
| 435 | - add_filter('wp_mail_from', array($this, 'set_from_address'), 100); |
|
| 436 | - add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100); |
|
| 437 | - return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this); |
|
| 438 | - } |
|
| 439 | - |
|
| 440 | - |
|
| 441 | - /** |
|
| 442 | - * This simply ensures that the from address is not empty. If it is, then we use whatever is set as the site email |
|
| 443 | - * address for the from address to avoid problems with sending emails. |
|
| 444 | - */ |
|
| 445 | - protected function _ensure_has_from_email_address() |
|
| 446 | - { |
|
| 447 | - if (empty($this->_from)) { |
|
| 448 | - $this->_from = get_bloginfo('admin_email'); |
|
| 449 | - } |
|
| 450 | - } |
|
| 451 | - |
|
| 452 | - |
|
| 453 | - /** |
|
| 454 | - * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}> |
|
| 455 | - * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY* |
|
| 456 | - * be empty |
|
| 457 | - * |
|
| 458 | - * @since 4.3.1 |
|
| 459 | - * @return array |
|
| 460 | - */ |
|
| 461 | - private function _parse_from() |
|
| 462 | - { |
|
| 463 | - if (strpos($this->_from, '<') !== false) { |
|
| 464 | - $from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1); |
|
| 465 | - $from_name = str_replace('"', '', $from_name); |
|
| 466 | - $from_name = trim($from_name); |
|
| 467 | - |
|
| 468 | - $from_email = substr($this->_from, strpos($this->_from, '<') + 1); |
|
| 469 | - $from_email = str_replace('>', '', $from_email); |
|
| 470 | - $from_email = trim($from_email); |
|
| 471 | - } elseif (trim($this->_from) !== '') { |
|
| 472 | - $from_name = ''; |
|
| 473 | - $from_email = trim($this->_from); |
|
| 474 | - } else { |
|
| 475 | - $from_name = $from_email = ''; |
|
| 476 | - } |
|
| 477 | - return array($from_name, $from_email); |
|
| 478 | - } |
|
| 479 | - |
|
| 480 | - |
|
| 481 | - /** |
|
| 482 | - * Callback for the wp_mail_from filter. |
|
| 483 | - * |
|
| 484 | - * @since 4.3.1 |
|
| 485 | - * @param string $from_email What the original from_email is. |
|
| 486 | - */ |
|
| 487 | - public function set_from_address($from_email) |
|
| 488 | - { |
|
| 489 | - $parsed_from = $this->_parse_from(); |
|
| 490 | - //includes fallback if the parsing failed. |
|
| 491 | - $from_email = is_array($parsed_from) && ! empty($parsed_from[1]) ? $parsed_from[1] : get_bloginfo('admin_email'); |
|
| 492 | - return $from_email; |
|
| 493 | - } |
|
| 494 | - |
|
| 495 | - |
|
| 496 | - /** |
|
| 497 | - * Callback fro the wp_mail_from_name filter. |
|
| 498 | - * |
|
| 499 | - * @since 4.3.1 |
|
| 500 | - * @param string $from_name The original from_name. |
|
| 501 | - */ |
|
| 502 | - public function set_from_name($from_name) |
|
| 503 | - { |
|
| 504 | - $parsed_from = $this->_parse_from(); |
|
| 505 | - if (is_array($parsed_from) && ! empty($parsed_from[0])) { |
|
| 506 | - $from_name = $parsed_from[0]; |
|
| 507 | - } |
|
| 508 | - |
|
| 509 | - //if from name is "WordPress" let's sub in the site name instead (more friendly!) |
|
| 510 | - $from_name = $from_name == 'WordPress' ? get_bloginfo() : $from_name; |
|
| 511 | - |
|
| 512 | - return stripslashes_deep(html_entity_decode($from_name, ENT_QUOTES, "UTF-8")); |
|
| 513 | - } |
|
| 514 | - |
|
| 515 | - |
|
| 516 | - /** |
|
| 517 | - * setup body for email |
|
| 518 | - * |
|
| 519 | - * @param bool $preview will determine whether this is preview template or not. |
|
| 520 | - * @return string formatted body for email. |
|
| 521 | - */ |
|
| 522 | - protected function _body($preview = false) |
|
| 523 | - { |
|
| 524 | - //setup template args! |
|
| 525 | - $this->_template_args = array( |
|
| 526 | - 'subject' => $this->_subject, |
|
| 527 | - 'from' => $this->_from, |
|
| 528 | - 'main_body' => wpautop(stripslashes_deep(html_entity_decode($this->_content, ENT_QUOTES, "UTF-8"))), |
|
| 529 | - ); |
|
| 530 | - $body = $this->_get_main_template($preview); |
|
| 531 | - |
|
| 532 | - /** |
|
| 533 | - * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched. |
|
| 534 | - * |
|
| 535 | - * @type bool $preview Indicates whether a preview is being generated or not. |
|
| 536 | - * @return bool true indicates to use the inliner, false bypasses it. |
|
| 537 | - */ |
|
| 538 | - if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) { |
|
| 539 | - |
|
| 540 | - //require CssToInlineStyles library and its dependencies via composer autoloader |
|
| 541 | - require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php'; |
|
| 542 | - |
|
| 543 | - //now if this isn't a preview, let's setup the body so it has inline styles |
|
| 544 | - if (! $preview || ($preview && defined('DOING_AJAX'))) { |
|
| 545 | - $style = file_get_contents($this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, |
|
| 546 | - false, 'main', $this->_variation), true); |
|
| 547 | - $CSS = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style); |
|
| 548 | - $body = ltrim($CSS->convert(true), |
|
| 549 | - ">\n"); //for some reason the library has a bracket and new line at the beginning. This takes care of that. |
|
| 550 | - $body = ltrim($body, "<?"); //see https://events.codebasehq.com/projects/event-espresso/tickets/8609 |
|
| 551 | - } |
|
| 552 | - |
|
| 553 | - } |
|
| 554 | - return $body; |
|
| 555 | - } |
|
| 556 | - |
|
| 557 | - |
|
| 558 | - /** |
|
| 559 | - * This just returns any existing test settings that might be saved in the database |
|
| 560 | - * |
|
| 561 | - * @access public |
|
| 562 | - * @return array |
|
| 563 | - */ |
|
| 564 | - public function get_existing_test_settings() |
|
| 565 | - { |
|
| 566 | - $settings = parent::get_existing_test_settings(); |
|
| 567 | - //override subject if present because we always want it to be fresh. |
|
| 568 | - if (is_array($settings) && ! empty($settings['subject'])) { |
|
| 569 | - $settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')); |
|
| 570 | - } |
|
| 571 | - return $settings; |
|
| 572 | - } |
|
| 31 | + /** |
|
| 32 | + * The following are the properties that email requires for the message going out. |
|
| 33 | + */ |
|
| 34 | + protected $_to; |
|
| 35 | + protected $_from; |
|
| 36 | + protected $_subject; |
|
| 37 | + protected $_content; |
|
| 38 | + |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * constructor |
|
| 42 | + * |
|
| 43 | + * @access public |
|
| 44 | + */ |
|
| 45 | + public function __construct() |
|
| 46 | + { |
|
| 47 | + //set name and description properties |
|
| 48 | + $this->name = 'email'; |
|
| 49 | + $this->description = __('This messenger delivers messages via email using the built-in <code>wp_mail</code> function included with WordPress', |
|
| 50 | + 'event_espresso'); |
|
| 51 | + $this->label = array( |
|
| 52 | + 'singular' => __('email', 'event_espresso'), |
|
| 53 | + 'plural' => __('emails', 'event_espresso'), |
|
| 54 | + ); |
|
| 55 | + $this->activate_on_install = true; |
|
| 56 | + |
|
| 57 | + //we're using defaults so let's call parent constructor that will take care of setting up all the other properties |
|
| 58 | + parent::__construct(); |
|
| 59 | + } |
|
| 60 | + |
|
| 61 | + |
|
| 62 | + /** |
|
| 63 | + * see abstract declaration in parent class for details. |
|
| 64 | + */ |
|
| 65 | + protected function _set_admin_pages() |
|
| 66 | + { |
|
| 67 | + $this->admin_registered_pages = array( |
|
| 68 | + 'events_edit' => true, |
|
| 69 | + ); |
|
| 70 | + } |
|
| 71 | + |
|
| 72 | + |
|
| 73 | + /** |
|
| 74 | + * see abstract declaration in parent class for details |
|
| 75 | + */ |
|
| 76 | + protected function _set_valid_shortcodes() |
|
| 77 | + { |
|
| 78 | + //remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the message type. |
|
| 79 | + $this->_valid_shortcodes = array( |
|
| 80 | + 'to' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'), |
|
| 81 | + 'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'), |
|
| 82 | + ); |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + |
|
| 86 | + /** |
|
| 87 | + * see abstract declaration in parent class for details |
|
| 88 | + * |
|
| 89 | + * @access protected |
|
| 90 | + * @return void |
|
| 91 | + */ |
|
| 92 | + protected function _set_validator_config() |
|
| 93 | + { |
|
| 94 | + $valid_shortcodes = $this->get_valid_shortcodes(); |
|
| 95 | + |
|
| 96 | + $this->_validator_config = array( |
|
| 97 | + 'to' => array( |
|
| 98 | + 'shortcodes' => $valid_shortcodes['to'], |
|
| 99 | + 'type' => 'email', |
|
| 100 | + ), |
|
| 101 | + 'from' => array( |
|
| 102 | + 'shortcodes' => $valid_shortcodes['from'], |
|
| 103 | + 'type' => 'email', |
|
| 104 | + ), |
|
| 105 | + 'subject' => array( |
|
| 106 | + 'shortcodes' => array( |
|
| 107 | + 'organization', |
|
| 108 | + 'primary_registration_details', |
|
| 109 | + 'event_author', |
|
| 110 | + 'primary_registration_details', |
|
| 111 | + 'recipient_details', |
|
| 112 | + ), |
|
| 113 | + ), |
|
| 114 | + 'content' => array( |
|
| 115 | + 'shortcodes' => array( |
|
| 116 | + 'event_list', |
|
| 117 | + 'attendee_list', |
|
| 118 | + 'ticket_list', |
|
| 119 | + 'organization', |
|
| 120 | + 'primary_registration_details', |
|
| 121 | + 'primary_registration_list', |
|
| 122 | + 'event_author', |
|
| 123 | + 'recipient_details', |
|
| 124 | + 'recipient_list', |
|
| 125 | + 'transaction', |
|
| 126 | + 'messenger', |
|
| 127 | + ), |
|
| 128 | + ), |
|
| 129 | + 'attendee_list' => array( |
|
| 130 | + 'shortcodes' => array('attendee', 'event_list', 'ticket_list'), |
|
| 131 | + 'required' => array('[ATTENDEE_LIST]'), |
|
| 132 | + ), |
|
| 133 | + 'event_list' => array( |
|
| 134 | + 'shortcodes' => array( |
|
| 135 | + 'event', |
|
| 136 | + 'attendee_list', |
|
| 137 | + 'ticket_list', |
|
| 138 | + 'venue', |
|
| 139 | + 'datetime_list', |
|
| 140 | + 'attendee', |
|
| 141 | + 'primary_registration_details', |
|
| 142 | + 'primary_registration_list', |
|
| 143 | + 'event_author', |
|
| 144 | + 'recipient_details', |
|
| 145 | + 'recipient_list', |
|
| 146 | + ), |
|
| 147 | + 'required' => array('[EVENT_LIST]'), |
|
| 148 | + ), |
|
| 149 | + 'ticket_list' => array( |
|
| 150 | + 'shortcodes' => array( |
|
| 151 | + 'event_list', |
|
| 152 | + 'attendee_list', |
|
| 153 | + 'ticket', |
|
| 154 | + 'datetime_list', |
|
| 155 | + 'primary_registration_details', |
|
| 156 | + 'recipient_details', |
|
| 157 | + ), |
|
| 158 | + 'required' => array('[TICKET_LIST]'), |
|
| 159 | + ), |
|
| 160 | + 'datetime_list' => array( |
|
| 161 | + 'shortcodes' => array('datetime'), |
|
| 162 | + 'required' => array('[DATETIME_LIST]'), |
|
| 163 | + ), |
|
| 164 | + ); |
|
| 165 | + } |
|
| 166 | + |
|
| 167 | + |
|
| 168 | + /** |
|
| 169 | + * @see parent EE_messenger class for docs |
|
| 170 | + * @since 4.5.0 |
|
| 171 | + */ |
|
| 172 | + public function do_secondary_messenger_hooks($sending_messenger_name) |
|
| 173 | + { |
|
| 174 | + if ($sending_messenger_name = 'html') { |
|
| 175 | + add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8); |
|
| 176 | + } |
|
| 177 | + } |
|
| 178 | + |
|
| 179 | + |
|
| 180 | + public function add_email_css( |
|
| 181 | + $variation_path, |
|
| 182 | + $messenger, |
|
| 183 | + $message_type, |
|
| 184 | + $type, |
|
| 185 | + $variation, |
|
| 186 | + $file_extension, |
|
| 187 | + $url, |
|
| 188 | + EE_Messages_Template_Pack $template_pack |
|
| 189 | + ) { |
|
| 190 | + //prevent recursion on this callback. |
|
| 191 | + remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10); |
|
| 192 | + $variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false); |
|
| 193 | + |
|
| 194 | + add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8); |
|
| 195 | + return $variation; |
|
| 196 | + } |
|
| 197 | + |
|
| 198 | + |
|
| 199 | + /** |
|
| 200 | + * See parent for details |
|
| 201 | + * |
|
| 202 | + * @access protected |
|
| 203 | + * @return void |
|
| 204 | + */ |
|
| 205 | + protected function _set_test_settings_fields() |
|
| 206 | + { |
|
| 207 | + $this->_test_settings_fields = array( |
|
| 208 | + 'to' => array( |
|
| 209 | + 'input' => 'text', |
|
| 210 | + 'label' => __('Send a test email to', 'event_espresso'), |
|
| 211 | + 'type' => 'email', |
|
| 212 | + 'required' => true, |
|
| 213 | + 'validation' => true, |
|
| 214 | + 'css_class' => 'large-text', |
|
| 215 | + 'format' => '%s', |
|
| 216 | + 'default' => get_bloginfo('admin_email'), |
|
| 217 | + ), |
|
| 218 | + 'subject' => array( |
|
| 219 | + 'input' => 'hidden', |
|
| 220 | + 'label' => '', |
|
| 221 | + 'type' => 'string', |
|
| 222 | + 'required' => false, |
|
| 223 | + 'validation' => false, |
|
| 224 | + 'format' => '%s', |
|
| 225 | + 'value' => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')), |
|
| 226 | + 'default' => '', |
|
| 227 | + 'css_class' => '', |
|
| 228 | + ), |
|
| 229 | + ); |
|
| 230 | + } |
|
| 231 | + |
|
| 232 | + |
|
| 233 | + /** |
|
| 234 | + * _set_template_fields |
|
| 235 | + * This sets up the fields that a messenger requires for the message to go out. |
|
| 236 | + * |
|
| 237 | + * @access protected |
|
| 238 | + * @return void |
|
| 239 | + */ |
|
| 240 | + protected function _set_template_fields() |
|
| 241 | + { |
|
| 242 | + // any extra template fields that are NOT used by the messenger but will get used by a messenger field for shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field they relate to. This is important for the Messages_admin to know what fields to display to the user. Also, notice that the "values" are equal to the field type that messages admin will use to know what kind of field to display. The values ALSO have one index labeled "shortcode". the values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be displayed. If the required shortcode isn't part of the shortcodes array then the field is not needed and will not be displayed/parsed. |
|
| 243 | + $this->_template_fields = array( |
|
| 244 | + 'to' => array( |
|
| 245 | + 'input' => 'text', |
|
| 246 | + 'label' => __('To', 'event_espresso'), |
|
| 247 | + 'type' => 'string', |
|
| 248 | + 'required' => true, |
|
| 249 | + 'validation' => true, |
|
| 250 | + 'css_class' => 'large-text', |
|
| 251 | + 'format' => '%s', |
|
| 252 | + ), |
|
| 253 | + 'from' => array( |
|
| 254 | + 'input' => 'text', |
|
| 255 | + 'label' => __('From', 'event_espresso'), |
|
| 256 | + 'type' => 'string', |
|
| 257 | + 'required' => true, |
|
| 258 | + 'validation' => true, |
|
| 259 | + 'css_class' => 'large-text', |
|
| 260 | + 'format' => '%s', |
|
| 261 | + ), |
|
| 262 | + 'subject' => array( |
|
| 263 | + 'input' => 'text', |
|
| 264 | + 'label' => __('Subject', 'event_espresso'), |
|
| 265 | + 'type' => 'string', |
|
| 266 | + 'required' => true, |
|
| 267 | + 'validation' => true, |
|
| 268 | + 'css_class' => 'large-text', |
|
| 269 | + 'format' => '%s', |
|
| 270 | + ), |
|
| 271 | + 'content' => '', |
|
| 272 | + //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field. |
|
| 273 | + 'extra' => array( |
|
| 274 | + 'content' => array( |
|
| 275 | + 'main' => array( |
|
| 276 | + 'input' => 'wp_editor', |
|
| 277 | + 'label' => __('Main Content', 'event_espresso'), |
|
| 278 | + 'type' => 'string', |
|
| 279 | + 'required' => true, |
|
| 280 | + 'validation' => true, |
|
| 281 | + 'format' => '%s', |
|
| 282 | + 'rows' => '15', |
|
| 283 | + ), |
|
| 284 | + 'event_list' => array( |
|
| 285 | + 'input' => 'wp_editor', |
|
| 286 | + 'label' => '[EVENT_LIST]', |
|
| 287 | + 'type' => 'string', |
|
| 288 | + 'required' => true, |
|
| 289 | + 'validation' => true, |
|
| 290 | + 'format' => '%s', |
|
| 291 | + 'rows' => '15', |
|
| 292 | + 'shortcodes_required' => array('[EVENT_LIST]'), |
|
| 293 | + ), |
|
| 294 | + 'attendee_list' => array( |
|
| 295 | + 'input' => 'textarea', |
|
| 296 | + 'label' => '[ATTENDEE_LIST]', |
|
| 297 | + 'type' => 'string', |
|
| 298 | + 'required' => true, |
|
| 299 | + 'validation' => true, |
|
| 300 | + 'format' => '%s', |
|
| 301 | + 'css_class' => 'large-text', |
|
| 302 | + 'rows' => '5', |
|
| 303 | + 'shortcodes_required' => array('[ATTENDEE_LIST]'), |
|
| 304 | + ), |
|
| 305 | + 'ticket_list' => array( |
|
| 306 | + 'input' => 'textarea', |
|
| 307 | + 'label' => '[TICKET_LIST]', |
|
| 308 | + 'type' => 'string', |
|
| 309 | + 'required' => true, |
|
| 310 | + 'validation' => true, |
|
| 311 | + 'format' => '%s', |
|
| 312 | + 'css_class' => 'large-text', |
|
| 313 | + 'rows' => '10', |
|
| 314 | + 'shortcodes_required' => array('[TICKET_LIST]'), |
|
| 315 | + ), |
|
| 316 | + 'datetime_list' => array( |
|
| 317 | + 'input' => 'textarea', |
|
| 318 | + 'label' => '[DATETIME_LIST]', |
|
| 319 | + 'type' => 'string', |
|
| 320 | + 'required' => true, |
|
| 321 | + 'validation' => true, |
|
| 322 | + 'format' => '%s', |
|
| 323 | + 'css_class' => 'large-text', |
|
| 324 | + 'rows' => '10', |
|
| 325 | + 'shortcodes_required' => array('[DATETIME_LIST]'), |
|
| 326 | + ), |
|
| 327 | + ), |
|
| 328 | + ), |
|
| 329 | + ); |
|
| 330 | + } |
|
| 331 | + |
|
| 332 | + |
|
| 333 | + /** |
|
| 334 | + * See definition of this class in parent |
|
| 335 | + */ |
|
| 336 | + protected function _set_default_message_types() |
|
| 337 | + { |
|
| 338 | + $this->_default_message_types = array( |
|
| 339 | + 'payment', |
|
| 340 | + 'payment_refund', |
|
| 341 | + 'registration', |
|
| 342 | + 'not_approved_registration', |
|
| 343 | + 'pending_approval', |
|
| 344 | + ); |
|
| 345 | + } |
|
| 346 | + |
|
| 347 | + |
|
| 348 | + /** |
|
| 349 | + * @see definition of this class in parent |
|
| 350 | + * @since 4.5.0 |
|
| 351 | + */ |
|
| 352 | + protected function _set_valid_message_types() |
|
| 353 | + { |
|
| 354 | + $this->_valid_message_types = array( |
|
| 355 | + 'payment', |
|
| 356 | + 'registration', |
|
| 357 | + 'not_approved_registration', |
|
| 358 | + 'declined_registration', |
|
| 359 | + 'cancelled_registration', |
|
| 360 | + 'pending_approval', |
|
| 361 | + 'registration_summary', |
|
| 362 | + 'payment_reminder', |
|
| 363 | + 'payment_declined', |
|
| 364 | + 'payment_refund', |
|
| 365 | + ); |
|
| 366 | + } |
|
| 367 | + |
|
| 368 | + |
|
| 369 | + /** |
|
| 370 | + * setting up admin_settings_fields for messenger. |
|
| 371 | + */ |
|
| 372 | + protected function _set_admin_settings_fields() |
|
| 373 | + { |
|
| 374 | + } |
|
| 375 | + |
|
| 376 | + /** |
|
| 377 | + * We just deliver the messages don't kill us!! |
|
| 378 | + * |
|
| 379 | + * @return bool | WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if |
|
| 380 | + * present. |
|
| 381 | + */ |
|
| 382 | + protected function _send_message() |
|
| 383 | + { |
|
| 384 | + $success = wp_mail( |
|
| 385 | + html_entity_decode($this->_to, ENT_QUOTES, "UTF-8"), |
|
| 386 | + stripslashes(html_entity_decode($this->_subject, ENT_QUOTES, "UTF-8")), |
|
| 387 | + $this->_body(), |
|
| 388 | + $this->_headers() |
|
| 389 | + ); |
|
| 390 | + if (! $success) { |
|
| 391 | + EE_Error::add_error( |
|
| 392 | + sprintf( |
|
| 393 | + __('The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s', |
|
| 394 | + 'event_espresso'), |
|
| 395 | + $this->_to, |
|
| 396 | + $this->_from, |
|
| 397 | + '<br />' |
|
| 398 | + ), |
|
| 399 | + __FILE__, __FUNCTION__, __LINE__ |
|
| 400 | + ); |
|
| 401 | + } |
|
| 402 | + return $success; |
|
| 403 | + } |
|
| 404 | + |
|
| 405 | + |
|
| 406 | + /** |
|
| 407 | + * see parent for definition |
|
| 408 | + * |
|
| 409 | + * @return string html body of the message content and the related css. |
|
| 410 | + */ |
|
| 411 | + protected function _preview() |
|
| 412 | + { |
|
| 413 | + return $this->_body(true); |
|
| 414 | + } |
|
| 415 | + |
|
| 416 | + |
|
| 417 | + /** |
|
| 418 | + * Setup headers for email |
|
| 419 | + * |
|
| 420 | + * @access protected |
|
| 421 | + * @return string formatted header for email |
|
| 422 | + */ |
|
| 423 | + protected function _headers() |
|
| 424 | + { |
|
| 425 | + $this->_ensure_has_from_email_address(); |
|
| 426 | + $from = stripslashes_deep(html_entity_decode($this->_from, ENT_QUOTES, "UTF-8")); |
|
| 427 | + $headers = array( |
|
| 428 | + 'MIME-Version: 1.0', |
|
| 429 | + 'From:' . $from, |
|
| 430 | + 'Reply-To:' . $from, |
|
| 431 | + 'Content-Type:text/html; charset=utf-8', |
|
| 432 | + ); |
|
| 433 | + |
|
| 434 | + //but wait! Header's for the from is NOT reliable because some plugins don't respect From: as set in the header. |
|
| 435 | + add_filter('wp_mail_from', array($this, 'set_from_address'), 100); |
|
| 436 | + add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100); |
|
| 437 | + return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this); |
|
| 438 | + } |
|
| 439 | + |
|
| 440 | + |
|
| 441 | + /** |
|
| 442 | + * This simply ensures that the from address is not empty. If it is, then we use whatever is set as the site email |
|
| 443 | + * address for the from address to avoid problems with sending emails. |
|
| 444 | + */ |
|
| 445 | + protected function _ensure_has_from_email_address() |
|
| 446 | + { |
|
| 447 | + if (empty($this->_from)) { |
|
| 448 | + $this->_from = get_bloginfo('admin_email'); |
|
| 449 | + } |
|
| 450 | + } |
|
| 451 | + |
|
| 452 | + |
|
| 453 | + /** |
|
| 454 | + * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}> |
|
| 455 | + * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY* |
|
| 456 | + * be empty |
|
| 457 | + * |
|
| 458 | + * @since 4.3.1 |
|
| 459 | + * @return array |
|
| 460 | + */ |
|
| 461 | + private function _parse_from() |
|
| 462 | + { |
|
| 463 | + if (strpos($this->_from, '<') !== false) { |
|
| 464 | + $from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1); |
|
| 465 | + $from_name = str_replace('"', '', $from_name); |
|
| 466 | + $from_name = trim($from_name); |
|
| 467 | + |
|
| 468 | + $from_email = substr($this->_from, strpos($this->_from, '<') + 1); |
|
| 469 | + $from_email = str_replace('>', '', $from_email); |
|
| 470 | + $from_email = trim($from_email); |
|
| 471 | + } elseif (trim($this->_from) !== '') { |
|
| 472 | + $from_name = ''; |
|
| 473 | + $from_email = trim($this->_from); |
|
| 474 | + } else { |
|
| 475 | + $from_name = $from_email = ''; |
|
| 476 | + } |
|
| 477 | + return array($from_name, $from_email); |
|
| 478 | + } |
|
| 479 | + |
|
| 480 | + |
|
| 481 | + /** |
|
| 482 | + * Callback for the wp_mail_from filter. |
|
| 483 | + * |
|
| 484 | + * @since 4.3.1 |
|
| 485 | + * @param string $from_email What the original from_email is. |
|
| 486 | + */ |
|
| 487 | + public function set_from_address($from_email) |
|
| 488 | + { |
|
| 489 | + $parsed_from = $this->_parse_from(); |
|
| 490 | + //includes fallback if the parsing failed. |
|
| 491 | + $from_email = is_array($parsed_from) && ! empty($parsed_from[1]) ? $parsed_from[1] : get_bloginfo('admin_email'); |
|
| 492 | + return $from_email; |
|
| 493 | + } |
|
| 494 | + |
|
| 495 | + |
|
| 496 | + /** |
|
| 497 | + * Callback fro the wp_mail_from_name filter. |
|
| 498 | + * |
|
| 499 | + * @since 4.3.1 |
|
| 500 | + * @param string $from_name The original from_name. |
|
| 501 | + */ |
|
| 502 | + public function set_from_name($from_name) |
|
| 503 | + { |
|
| 504 | + $parsed_from = $this->_parse_from(); |
|
| 505 | + if (is_array($parsed_from) && ! empty($parsed_from[0])) { |
|
| 506 | + $from_name = $parsed_from[0]; |
|
| 507 | + } |
|
| 508 | + |
|
| 509 | + //if from name is "WordPress" let's sub in the site name instead (more friendly!) |
|
| 510 | + $from_name = $from_name == 'WordPress' ? get_bloginfo() : $from_name; |
|
| 511 | + |
|
| 512 | + return stripslashes_deep(html_entity_decode($from_name, ENT_QUOTES, "UTF-8")); |
|
| 513 | + } |
|
| 514 | + |
|
| 515 | + |
|
| 516 | + /** |
|
| 517 | + * setup body for email |
|
| 518 | + * |
|
| 519 | + * @param bool $preview will determine whether this is preview template or not. |
|
| 520 | + * @return string formatted body for email. |
|
| 521 | + */ |
|
| 522 | + protected function _body($preview = false) |
|
| 523 | + { |
|
| 524 | + //setup template args! |
|
| 525 | + $this->_template_args = array( |
|
| 526 | + 'subject' => $this->_subject, |
|
| 527 | + 'from' => $this->_from, |
|
| 528 | + 'main_body' => wpautop(stripslashes_deep(html_entity_decode($this->_content, ENT_QUOTES, "UTF-8"))), |
|
| 529 | + ); |
|
| 530 | + $body = $this->_get_main_template($preview); |
|
| 531 | + |
|
| 532 | + /** |
|
| 533 | + * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched. |
|
| 534 | + * |
|
| 535 | + * @type bool $preview Indicates whether a preview is being generated or not. |
|
| 536 | + * @return bool true indicates to use the inliner, false bypasses it. |
|
| 537 | + */ |
|
| 538 | + if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) { |
|
| 539 | + |
|
| 540 | + //require CssToInlineStyles library and its dependencies via composer autoloader |
|
| 541 | + require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php'; |
|
| 542 | + |
|
| 543 | + //now if this isn't a preview, let's setup the body so it has inline styles |
|
| 544 | + if (! $preview || ($preview && defined('DOING_AJAX'))) { |
|
| 545 | + $style = file_get_contents($this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, |
|
| 546 | + false, 'main', $this->_variation), true); |
|
| 547 | + $CSS = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style); |
|
| 548 | + $body = ltrim($CSS->convert(true), |
|
| 549 | + ">\n"); //for some reason the library has a bracket and new line at the beginning. This takes care of that. |
|
| 550 | + $body = ltrim($body, "<?"); //see https://events.codebasehq.com/projects/event-espresso/tickets/8609 |
|
| 551 | + } |
|
| 552 | + |
|
| 553 | + } |
|
| 554 | + return $body; |
|
| 555 | + } |
|
| 556 | + |
|
| 557 | + |
|
| 558 | + /** |
|
| 559 | + * This just returns any existing test settings that might be saved in the database |
|
| 560 | + * |
|
| 561 | + * @access public |
|
| 562 | + * @return array |
|
| 563 | + */ |
|
| 564 | + public function get_existing_test_settings() |
|
| 565 | + { |
|
| 566 | + $settings = parent::get_existing_test_settings(); |
|
| 567 | + //override subject if present because we always want it to be fresh. |
|
| 568 | + if (is_array($settings) && ! empty($settings['subject'])) { |
|
| 569 | + $settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')); |
|
| 570 | + } |
|
| 571 | + return $settings; |
|
| 572 | + } |
|
| 573 | 573 | |
| 574 | 574 | |
| 575 | 575 | } |
@@ -1,6 +1,6 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | |
| 3 | -if (! defined('EVENT_ESPRESSO_VERSION')) { |
|
| 3 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
| 4 | 4 | exit('NO direct script access allowed'); |
| 5 | 5 | } |
| 6 | 6 | |
@@ -387,7 +387,7 @@ discard block |
||
| 387 | 387 | $this->_body(), |
| 388 | 388 | $this->_headers() |
| 389 | 389 | ); |
| 390 | - if (! $success) { |
|
| 390 | + if ( ! $success) { |
|
| 391 | 391 | EE_Error::add_error( |
| 392 | 392 | sprintf( |
| 393 | 393 | __('The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s', |
@@ -426,8 +426,8 @@ discard block |
||
| 426 | 426 | $from = stripslashes_deep(html_entity_decode($this->_from, ENT_QUOTES, "UTF-8")); |
| 427 | 427 | $headers = array( |
| 428 | 428 | 'MIME-Version: 1.0', |
| 429 | - 'From:' . $from, |
|
| 430 | - 'Reply-To:' . $from, |
|
| 429 | + 'From:'.$from, |
|
| 430 | + 'Reply-To:'.$from, |
|
| 431 | 431 | 'Content-Type:text/html; charset=utf-8', |
| 432 | 432 | ); |
| 433 | 433 | |
@@ -527,7 +527,7 @@ discard block |
||
| 527 | 527 | 'from' => $this->_from, |
| 528 | 528 | 'main_body' => wpautop(stripslashes_deep(html_entity_decode($this->_content, ENT_QUOTES, "UTF-8"))), |
| 529 | 529 | ); |
| 530 | - $body = $this->_get_main_template($preview); |
|
| 530 | + $body = $this->_get_main_template($preview); |
|
| 531 | 531 | |
| 532 | 532 | /** |
| 533 | 533 | * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched. |
@@ -538,10 +538,10 @@ discard block |
||
| 538 | 538 | if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) { |
| 539 | 539 | |
| 540 | 540 | //require CssToInlineStyles library and its dependencies via composer autoloader |
| 541 | - require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php'; |
|
| 541 | + require_once EE_THIRD_PARTY.'cssinliner/vendor/autoload.php'; |
|
| 542 | 542 | |
| 543 | 543 | //now if this isn't a preview, let's setup the body so it has inline styles |
| 544 | - if (! $preview || ($preview && defined('DOING_AJAX'))) { |
|
| 544 | + if ( ! $preview || ($preview && defined('DOING_AJAX'))) { |
|
| 545 | 545 | $style = file_get_contents($this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, |
| 546 | 546 | false, 'main', $this->_variation), true); |
| 547 | 547 | $CSS = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style); |
@@ -5,8 +5,8 @@ discard block |
||
| 5 | 5 | // if you're a dev and want to receive all errors via email |
| 6 | 6 | // add this to your wp-config.php: define( 'EE_ERROR_EMAILS', TRUE ); |
| 7 | 7 | if (defined('WP_DEBUG') && WP_DEBUG === true && defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS === true) { |
| 8 | - set_error_handler(array('EE_Error', 'error_handler')); |
|
| 9 | - register_shutdown_function(array('EE_Error', 'fatal_error_handler')); |
|
| 8 | + set_error_handler(array('EE_Error', 'error_handler')); |
|
| 9 | + register_shutdown_function(array('EE_Error', 'fatal_error_handler')); |
|
| 10 | 10 | } |
| 11 | 11 | |
| 12 | 12 | |
@@ -23,259 +23,259 @@ discard block |
||
| 23 | 23 | { |
| 24 | 24 | |
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * name of the file to log exceptions to |
|
| 28 | - * |
|
| 29 | - * @var string |
|
| 30 | - */ |
|
| 31 | - private static $_exception_log_file = 'espresso_error_log.txt'; |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * stores details for all exception |
|
| 35 | - * |
|
| 36 | - * @var array |
|
| 37 | - */ |
|
| 38 | - private static $_all_exceptions = array(); |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * tracks number of errors |
|
| 42 | - * |
|
| 43 | - * @var int |
|
| 44 | - */ |
|
| 45 | - private static $_error_count = 0; |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * has shutdown action been added ? |
|
| 49 | - * |
|
| 50 | - * @var array $_espresso_notices |
|
| 51 | - */ |
|
| 52 | - private static $_espresso_notices = array('success' => false, 'errors' => false, 'attention' => false); |
|
| 53 | - |
|
| 54 | - |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * @override default exception handling |
|
| 58 | - * @param string $message |
|
| 59 | - * @param int $code |
|
| 60 | - * @param Exception|null $previous |
|
| 61 | - */ |
|
| 62 | - public function __construct($message, $code = 0, Exception $previous = null) |
|
| 63 | - { |
|
| 64 | - if (version_compare(PHP_VERSION, '5.3.0', '<')) { |
|
| 65 | - parent::__construct($message, $code); |
|
| 66 | - } else { |
|
| 67 | - parent::__construct($message, $code, $previous); |
|
| 68 | - } |
|
| 69 | - } |
|
| 70 | - |
|
| 71 | - |
|
| 72 | - |
|
| 73 | - /** |
|
| 74 | - * error_handler |
|
| 75 | - * |
|
| 76 | - * @param $code |
|
| 77 | - * @param $message |
|
| 78 | - * @param $file |
|
| 79 | - * @param $line |
|
| 80 | - * @return void |
|
| 81 | - */ |
|
| 82 | - public static function error_handler($code, $message, $file, $line) |
|
| 83 | - { |
|
| 84 | - $type = EE_Error::error_type($code); |
|
| 85 | - $site = site_url(); |
|
| 86 | - switch ($site) { |
|
| 87 | - case 'http://ee4.eventespresso.com/' : |
|
| 88 | - case 'http://ee4decaf.eventespresso.com/' : |
|
| 89 | - case 'http://ee4hf.eventespresso.com/' : |
|
| 90 | - case 'http://ee4a.eventespresso.com/' : |
|
| 91 | - case 'http://ee4ad.eventespresso.com/' : |
|
| 92 | - case 'http://ee4b.eventespresso.com/' : |
|
| 93 | - case 'http://ee4bd.eventespresso.com/' : |
|
| 94 | - case 'http://ee4d.eventespresso.com/' : |
|
| 95 | - case 'http://ee4dd.eventespresso.com/' : |
|
| 96 | - $to = '[email protected]'; |
|
| 97 | - break; |
|
| 98 | - default : |
|
| 99 | - $to = get_option('admin_email'); |
|
| 100 | - } |
|
| 101 | - $subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url(); |
|
| 102 | - $msg = EE_Error::_format_error($type, $message, $file, $line); |
|
| 103 | - if (function_exists('wp_mail')) { |
|
| 104 | - add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type')); |
|
| 105 | - wp_mail($to, $subject, $msg); |
|
| 106 | - } |
|
| 107 | - echo '<div id="message" class="espresso-notices error"><p>'; |
|
| 108 | - echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line; |
|
| 109 | - echo '<br /></p></div>'; |
|
| 110 | - } |
|
| 111 | - |
|
| 112 | - |
|
| 113 | - |
|
| 114 | - /** |
|
| 115 | - * error_type |
|
| 116 | - * http://www.php.net/manual/en/errorfunc.constants.php#109430 |
|
| 117 | - * |
|
| 118 | - * @param $code |
|
| 119 | - * @return string |
|
| 120 | - */ |
|
| 121 | - public static function error_type($code) |
|
| 122 | - { |
|
| 123 | - switch ($code) { |
|
| 124 | - case E_ERROR: // 1 // |
|
| 125 | - return 'E_ERROR'; |
|
| 126 | - case E_WARNING: // 2 // |
|
| 127 | - return 'E_WARNING'; |
|
| 128 | - case E_PARSE: // 4 // |
|
| 129 | - return 'E_PARSE'; |
|
| 130 | - case E_NOTICE: // 8 // |
|
| 131 | - return 'E_NOTICE'; |
|
| 132 | - case E_CORE_ERROR: // 16 // |
|
| 133 | - return 'E_CORE_ERROR'; |
|
| 134 | - case E_CORE_WARNING: // 32 // |
|
| 135 | - return 'E_CORE_WARNING'; |
|
| 136 | - case E_COMPILE_ERROR: // 64 // |
|
| 137 | - return 'E_COMPILE_ERROR'; |
|
| 138 | - case E_COMPILE_WARNING: // 128 // |
|
| 139 | - return 'E_COMPILE_WARNING'; |
|
| 140 | - case E_USER_ERROR: // 256 // |
|
| 141 | - return 'E_USER_ERROR'; |
|
| 142 | - case E_USER_WARNING: // 512 // |
|
| 143 | - return 'E_USER_WARNING'; |
|
| 144 | - case E_USER_NOTICE: // 1024 // |
|
| 145 | - return 'E_USER_NOTICE'; |
|
| 146 | - case E_STRICT: // 2048 // |
|
| 147 | - return 'E_STRICT'; |
|
| 148 | - case E_RECOVERABLE_ERROR: // 4096 // |
|
| 149 | - return 'E_RECOVERABLE_ERROR'; |
|
| 150 | - case E_DEPRECATED: // 8192 // |
|
| 151 | - return 'E_DEPRECATED'; |
|
| 152 | - case E_USER_DEPRECATED: // 16384 // |
|
| 153 | - return 'E_USER_DEPRECATED'; |
|
| 154 | - case E_ALL: // 16384 // |
|
| 155 | - return 'E_ALL'; |
|
| 156 | - } |
|
| 157 | - return ''; |
|
| 158 | - } |
|
| 159 | - |
|
| 160 | - |
|
| 161 | - |
|
| 162 | - /** |
|
| 163 | - * fatal_error_handler |
|
| 164 | - * |
|
| 165 | - * @return void |
|
| 166 | - */ |
|
| 167 | - public static function fatal_error_handler() |
|
| 168 | - { |
|
| 169 | - $last_error = error_get_last(); |
|
| 170 | - if ($last_error['type'] === E_ERROR) { |
|
| 171 | - EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']); |
|
| 172 | - } |
|
| 173 | - } |
|
| 174 | - |
|
| 175 | - |
|
| 176 | - |
|
| 177 | - /** |
|
| 178 | - * _format_error |
|
| 179 | - * |
|
| 180 | - * @param $code |
|
| 181 | - * @param $message |
|
| 182 | - * @param $file |
|
| 183 | - * @param $line |
|
| 184 | - * @return string |
|
| 185 | - */ |
|
| 186 | - private static function _format_error($code, $message, $file, $line) |
|
| 187 | - { |
|
| 188 | - $html = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>"; |
|
| 189 | - $html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>"; |
|
| 190 | - $html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>"; |
|
| 191 | - $html .= "<tr valign='top'><td><b>File</b></td><td>$file</td></tr>"; |
|
| 192 | - $html .= "<tr valign='top'><td><b>Line</b></td><td>$line</td></tr>"; |
|
| 193 | - $html .= '</tbody></table>'; |
|
| 194 | - return $html; |
|
| 195 | - } |
|
| 196 | - |
|
| 197 | - |
|
| 198 | - |
|
| 199 | - /** |
|
| 200 | - * set_content_type |
|
| 201 | - * |
|
| 202 | - * @param $content_type |
|
| 203 | - * @return string |
|
| 204 | - */ |
|
| 205 | - public static function set_content_type($content_type) |
|
| 206 | - { |
|
| 207 | - return 'text/html'; |
|
| 208 | - } |
|
| 209 | - |
|
| 210 | - |
|
| 211 | - |
|
| 212 | - /** |
|
| 213 | - * @return void |
|
| 214 | - * @throws EE_Error |
|
| 215 | - * @throws ReflectionException |
|
| 216 | - */ |
|
| 217 | - public function get_error() |
|
| 218 | - { |
|
| 219 | - if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) { |
|
| 220 | - throw $this; |
|
| 221 | - } |
|
| 222 | - // get separate user and developer messages if they exist |
|
| 223 | - $msg = explode('||', $this->getMessage()); |
|
| 224 | - $user_msg = $msg[0]; |
|
| 225 | - $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0]; |
|
| 226 | - $msg = WP_DEBUG ? $dev_msg : $user_msg; |
|
| 227 | - // add details to _all_exceptions array |
|
| 228 | - $x_time = time(); |
|
| 229 | - self::$_all_exceptions[$x_time]['name'] = get_class($this); |
|
| 230 | - self::$_all_exceptions[$x_time]['file'] = $this->getFile(); |
|
| 231 | - self::$_all_exceptions[$x_time]['line'] = $this->getLine(); |
|
| 232 | - self::$_all_exceptions[$x_time]['msg'] = $msg; |
|
| 233 | - self::$_all_exceptions[$x_time]['code'] = $this->getCode(); |
|
| 234 | - self::$_all_exceptions[$x_time]['trace'] = $this->getTrace(); |
|
| 235 | - self::$_all_exceptions[$x_time]['string'] = $this->getTraceAsString(); |
|
| 236 | - self::$_error_count++; |
|
| 237 | - //add_action( 'shutdown', array( $this, 'display_errors' )); |
|
| 238 | - $this->display_errors(); |
|
| 239 | - } |
|
| 240 | - |
|
| 241 | - |
|
| 242 | - |
|
| 243 | - /** |
|
| 244 | - * has_error |
|
| 245 | - * |
|
| 246 | - * @param bool $check_stored |
|
| 247 | - * @param string $type_to_check |
|
| 248 | - * @return bool |
|
| 249 | - */ |
|
| 250 | - public static function has_error($check_stored = false, $type_to_check = 'errors') |
|
| 251 | - { |
|
| 252 | - $has_error = isset(self::$_espresso_notices[$type_to_check]) |
|
| 253 | - && ! empty(self::$_espresso_notices[$type_to_check]) |
|
| 254 | - ? true |
|
| 255 | - : false; |
|
| 256 | - if ($check_stored && ! $has_error) { |
|
| 257 | - $notices = (array)get_option('ee_notices', array()); |
|
| 258 | - foreach ($notices as $type => $notice) { |
|
| 259 | - if ($type === $type_to_check && $notice) { |
|
| 260 | - return true; |
|
| 261 | - } |
|
| 262 | - } |
|
| 263 | - } |
|
| 264 | - return $has_error; |
|
| 265 | - } |
|
| 266 | - |
|
| 267 | - |
|
| 268 | - |
|
| 269 | - /** |
|
| 270 | - * display_errors |
|
| 271 | - * |
|
| 272 | - * @echo string |
|
| 273 | - * @throws \ReflectionException |
|
| 274 | - */ |
|
| 275 | - public function display_errors() |
|
| 276 | - { |
|
| 277 | - $trace_details = ''; |
|
| 278 | - $output = ' |
|
| 26 | + /** |
|
| 27 | + * name of the file to log exceptions to |
|
| 28 | + * |
|
| 29 | + * @var string |
|
| 30 | + */ |
|
| 31 | + private static $_exception_log_file = 'espresso_error_log.txt'; |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * stores details for all exception |
|
| 35 | + * |
|
| 36 | + * @var array |
|
| 37 | + */ |
|
| 38 | + private static $_all_exceptions = array(); |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * tracks number of errors |
|
| 42 | + * |
|
| 43 | + * @var int |
|
| 44 | + */ |
|
| 45 | + private static $_error_count = 0; |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * has shutdown action been added ? |
|
| 49 | + * |
|
| 50 | + * @var array $_espresso_notices |
|
| 51 | + */ |
|
| 52 | + private static $_espresso_notices = array('success' => false, 'errors' => false, 'attention' => false); |
|
| 53 | + |
|
| 54 | + |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * @override default exception handling |
|
| 58 | + * @param string $message |
|
| 59 | + * @param int $code |
|
| 60 | + * @param Exception|null $previous |
|
| 61 | + */ |
|
| 62 | + public function __construct($message, $code = 0, Exception $previous = null) |
|
| 63 | + { |
|
| 64 | + if (version_compare(PHP_VERSION, '5.3.0', '<')) { |
|
| 65 | + parent::__construct($message, $code); |
|
| 66 | + } else { |
|
| 67 | + parent::__construct($message, $code, $previous); |
|
| 68 | + } |
|
| 69 | + } |
|
| 70 | + |
|
| 71 | + |
|
| 72 | + |
|
| 73 | + /** |
|
| 74 | + * error_handler |
|
| 75 | + * |
|
| 76 | + * @param $code |
|
| 77 | + * @param $message |
|
| 78 | + * @param $file |
|
| 79 | + * @param $line |
|
| 80 | + * @return void |
|
| 81 | + */ |
|
| 82 | + public static function error_handler($code, $message, $file, $line) |
|
| 83 | + { |
|
| 84 | + $type = EE_Error::error_type($code); |
|
| 85 | + $site = site_url(); |
|
| 86 | + switch ($site) { |
|
| 87 | + case 'http://ee4.eventespresso.com/' : |
|
| 88 | + case 'http://ee4decaf.eventespresso.com/' : |
|
| 89 | + case 'http://ee4hf.eventespresso.com/' : |
|
| 90 | + case 'http://ee4a.eventespresso.com/' : |
|
| 91 | + case 'http://ee4ad.eventespresso.com/' : |
|
| 92 | + case 'http://ee4b.eventespresso.com/' : |
|
| 93 | + case 'http://ee4bd.eventespresso.com/' : |
|
| 94 | + case 'http://ee4d.eventespresso.com/' : |
|
| 95 | + case 'http://ee4dd.eventespresso.com/' : |
|
| 96 | + $to = '[email protected]'; |
|
| 97 | + break; |
|
| 98 | + default : |
|
| 99 | + $to = get_option('admin_email'); |
|
| 100 | + } |
|
| 101 | + $subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url(); |
|
| 102 | + $msg = EE_Error::_format_error($type, $message, $file, $line); |
|
| 103 | + if (function_exists('wp_mail')) { |
|
| 104 | + add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type')); |
|
| 105 | + wp_mail($to, $subject, $msg); |
|
| 106 | + } |
|
| 107 | + echo '<div id="message" class="espresso-notices error"><p>'; |
|
| 108 | + echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line; |
|
| 109 | + echo '<br /></p></div>'; |
|
| 110 | + } |
|
| 111 | + |
|
| 112 | + |
|
| 113 | + |
|
| 114 | + /** |
|
| 115 | + * error_type |
|
| 116 | + * http://www.php.net/manual/en/errorfunc.constants.php#109430 |
|
| 117 | + * |
|
| 118 | + * @param $code |
|
| 119 | + * @return string |
|
| 120 | + */ |
|
| 121 | + public static function error_type($code) |
|
| 122 | + { |
|
| 123 | + switch ($code) { |
|
| 124 | + case E_ERROR: // 1 // |
|
| 125 | + return 'E_ERROR'; |
|
| 126 | + case E_WARNING: // 2 // |
|
| 127 | + return 'E_WARNING'; |
|
| 128 | + case E_PARSE: // 4 // |
|
| 129 | + return 'E_PARSE'; |
|
| 130 | + case E_NOTICE: // 8 // |
|
| 131 | + return 'E_NOTICE'; |
|
| 132 | + case E_CORE_ERROR: // 16 // |
|
| 133 | + return 'E_CORE_ERROR'; |
|
| 134 | + case E_CORE_WARNING: // 32 // |
|
| 135 | + return 'E_CORE_WARNING'; |
|
| 136 | + case E_COMPILE_ERROR: // 64 // |
|
| 137 | + return 'E_COMPILE_ERROR'; |
|
| 138 | + case E_COMPILE_WARNING: // 128 // |
|
| 139 | + return 'E_COMPILE_WARNING'; |
|
| 140 | + case E_USER_ERROR: // 256 // |
|
| 141 | + return 'E_USER_ERROR'; |
|
| 142 | + case E_USER_WARNING: // 512 // |
|
| 143 | + return 'E_USER_WARNING'; |
|
| 144 | + case E_USER_NOTICE: // 1024 // |
|
| 145 | + return 'E_USER_NOTICE'; |
|
| 146 | + case E_STRICT: // 2048 // |
|
| 147 | + return 'E_STRICT'; |
|
| 148 | + case E_RECOVERABLE_ERROR: // 4096 // |
|
| 149 | + return 'E_RECOVERABLE_ERROR'; |
|
| 150 | + case E_DEPRECATED: // 8192 // |
|
| 151 | + return 'E_DEPRECATED'; |
|
| 152 | + case E_USER_DEPRECATED: // 16384 // |
|
| 153 | + return 'E_USER_DEPRECATED'; |
|
| 154 | + case E_ALL: // 16384 // |
|
| 155 | + return 'E_ALL'; |
|
| 156 | + } |
|
| 157 | + return ''; |
|
| 158 | + } |
|
| 159 | + |
|
| 160 | + |
|
| 161 | + |
|
| 162 | + /** |
|
| 163 | + * fatal_error_handler |
|
| 164 | + * |
|
| 165 | + * @return void |
|
| 166 | + */ |
|
| 167 | + public static function fatal_error_handler() |
|
| 168 | + { |
|
| 169 | + $last_error = error_get_last(); |
|
| 170 | + if ($last_error['type'] === E_ERROR) { |
|
| 171 | + EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']); |
|
| 172 | + } |
|
| 173 | + } |
|
| 174 | + |
|
| 175 | + |
|
| 176 | + |
|
| 177 | + /** |
|
| 178 | + * _format_error |
|
| 179 | + * |
|
| 180 | + * @param $code |
|
| 181 | + * @param $message |
|
| 182 | + * @param $file |
|
| 183 | + * @param $line |
|
| 184 | + * @return string |
|
| 185 | + */ |
|
| 186 | + private static function _format_error($code, $message, $file, $line) |
|
| 187 | + { |
|
| 188 | + $html = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>"; |
|
| 189 | + $html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>"; |
|
| 190 | + $html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>"; |
|
| 191 | + $html .= "<tr valign='top'><td><b>File</b></td><td>$file</td></tr>"; |
|
| 192 | + $html .= "<tr valign='top'><td><b>Line</b></td><td>$line</td></tr>"; |
|
| 193 | + $html .= '</tbody></table>'; |
|
| 194 | + return $html; |
|
| 195 | + } |
|
| 196 | + |
|
| 197 | + |
|
| 198 | + |
|
| 199 | + /** |
|
| 200 | + * set_content_type |
|
| 201 | + * |
|
| 202 | + * @param $content_type |
|
| 203 | + * @return string |
|
| 204 | + */ |
|
| 205 | + public static function set_content_type($content_type) |
|
| 206 | + { |
|
| 207 | + return 'text/html'; |
|
| 208 | + } |
|
| 209 | + |
|
| 210 | + |
|
| 211 | + |
|
| 212 | + /** |
|
| 213 | + * @return void |
|
| 214 | + * @throws EE_Error |
|
| 215 | + * @throws ReflectionException |
|
| 216 | + */ |
|
| 217 | + public function get_error() |
|
| 218 | + { |
|
| 219 | + if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', false)) { |
|
| 220 | + throw $this; |
|
| 221 | + } |
|
| 222 | + // get separate user and developer messages if they exist |
|
| 223 | + $msg = explode('||', $this->getMessage()); |
|
| 224 | + $user_msg = $msg[0]; |
|
| 225 | + $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0]; |
|
| 226 | + $msg = WP_DEBUG ? $dev_msg : $user_msg; |
|
| 227 | + // add details to _all_exceptions array |
|
| 228 | + $x_time = time(); |
|
| 229 | + self::$_all_exceptions[$x_time]['name'] = get_class($this); |
|
| 230 | + self::$_all_exceptions[$x_time]['file'] = $this->getFile(); |
|
| 231 | + self::$_all_exceptions[$x_time]['line'] = $this->getLine(); |
|
| 232 | + self::$_all_exceptions[$x_time]['msg'] = $msg; |
|
| 233 | + self::$_all_exceptions[$x_time]['code'] = $this->getCode(); |
|
| 234 | + self::$_all_exceptions[$x_time]['trace'] = $this->getTrace(); |
|
| 235 | + self::$_all_exceptions[$x_time]['string'] = $this->getTraceAsString(); |
|
| 236 | + self::$_error_count++; |
|
| 237 | + //add_action( 'shutdown', array( $this, 'display_errors' )); |
|
| 238 | + $this->display_errors(); |
|
| 239 | + } |
|
| 240 | + |
|
| 241 | + |
|
| 242 | + |
|
| 243 | + /** |
|
| 244 | + * has_error |
|
| 245 | + * |
|
| 246 | + * @param bool $check_stored |
|
| 247 | + * @param string $type_to_check |
|
| 248 | + * @return bool |
|
| 249 | + */ |
|
| 250 | + public static function has_error($check_stored = false, $type_to_check = 'errors') |
|
| 251 | + { |
|
| 252 | + $has_error = isset(self::$_espresso_notices[$type_to_check]) |
|
| 253 | + && ! empty(self::$_espresso_notices[$type_to_check]) |
|
| 254 | + ? true |
|
| 255 | + : false; |
|
| 256 | + if ($check_stored && ! $has_error) { |
|
| 257 | + $notices = (array)get_option('ee_notices', array()); |
|
| 258 | + foreach ($notices as $type => $notice) { |
|
| 259 | + if ($type === $type_to_check && $notice) { |
|
| 260 | + return true; |
|
| 261 | + } |
|
| 262 | + } |
|
| 263 | + } |
|
| 264 | + return $has_error; |
|
| 265 | + } |
|
| 266 | + |
|
| 267 | + |
|
| 268 | + |
|
| 269 | + /** |
|
| 270 | + * display_errors |
|
| 271 | + * |
|
| 272 | + * @echo string |
|
| 273 | + * @throws \ReflectionException |
|
| 274 | + */ |
|
| 275 | + public function display_errors() |
|
| 276 | + { |
|
| 277 | + $trace_details = ''; |
|
| 278 | + $output = ' |
|
| 279 | 279 | <style type="text/css"> |
| 280 | 280 | #ee-error-message { |
| 281 | 281 | max-width:90% !important; |
@@ -331,19 +331,19 @@ discard block |
||
| 331 | 331 | } |
| 332 | 332 | </style> |
| 333 | 333 | <div id="ee-error-message" class="error">'; |
| 334 | - if (! WP_DEBUG) { |
|
| 335 | - $output .= ' |
|
| 334 | + if (! WP_DEBUG) { |
|
| 335 | + $output .= ' |
|
| 336 | 336 | <p>'; |
| 337 | - } |
|
| 338 | - // cycle thru errors |
|
| 339 | - foreach (self::$_all_exceptions as $time => $ex) { |
|
| 340 | - $error_code = ''; |
|
| 341 | - // process trace info |
|
| 342 | - if (empty($ex['trace'])) { |
|
| 343 | - $trace_details .= __('Sorry, but no trace information was available for this exception.', |
|
| 344 | - 'event_espresso'); |
|
| 345 | - } else { |
|
| 346 | - $trace_details .= ' |
|
| 337 | + } |
|
| 338 | + // cycle thru errors |
|
| 339 | + foreach (self::$_all_exceptions as $time => $ex) { |
|
| 340 | + $error_code = ''; |
|
| 341 | + // process trace info |
|
| 342 | + if (empty($ex['trace'])) { |
|
| 343 | + $trace_details .= __('Sorry, but no trace information was available for this exception.', |
|
| 344 | + 'event_espresso'); |
|
| 345 | + } else { |
|
| 346 | + $trace_details .= ' |
|
| 347 | 347 | <div id="ee-trace-details"> |
| 348 | 348 | <table width="100%" border="0" cellpadding="5" cellspacing="0"> |
| 349 | 349 | <tr> |
@@ -353,38 +353,38 @@ discard block |
||
| 353 | 353 | <th scope="col" align="left">Class</th> |
| 354 | 354 | <th scope="col" align="left">Method( arguments )</th> |
| 355 | 355 | </tr>'; |
| 356 | - $last_on_stack = count($ex['trace']) - 1; |
|
| 357 | - // reverse array so that stack is in proper chronological order |
|
| 358 | - $sorted_trace = array_reverse($ex['trace']); |
|
| 359 | - foreach ($sorted_trace as $nmbr => $trace) { |
|
| 360 | - $file = isset($trace['file']) ? $trace['file'] : ''; |
|
| 361 | - $class = isset($trace['class']) ? $trace['class'] : ''; |
|
| 362 | - $type = isset($trace['type']) ? $trace['type'] : ''; |
|
| 363 | - $function = isset($trace['function']) ? $trace['function'] : ''; |
|
| 364 | - $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : ''; |
|
| 365 | - $line = isset($trace['line']) ? $trace['line'] : ''; |
|
| 366 | - $zebra = ($nmbr % 2) ? ' odd' : ''; |
|
| 367 | - if (empty($file) && ! empty($class)) { |
|
| 368 | - $a = new ReflectionClass($class); |
|
| 369 | - $file = $a->getFileName(); |
|
| 370 | - if (empty($line) && ! empty($function)) { |
|
| 371 | - $b = new ReflectionMethod($class, $function); |
|
| 372 | - $line = $b->getStartLine(); |
|
| 373 | - } |
|
| 374 | - } |
|
| 375 | - if ($nmbr === $last_on_stack) { |
|
| 376 | - $file = $ex['file'] !== '' ? $ex['file'] : $file; |
|
| 377 | - $line = $ex['line'] !== '' ? $ex['line'] : $line; |
|
| 378 | - $error_code = self::generate_error_code($file, $trace['function'], $line); |
|
| 379 | - } |
|
| 380 | - $nmbr_dsply = ! empty($nmbr) ? $nmbr : ' '; |
|
| 381 | - $line_dsply = ! empty($line) ? $line : ' '; |
|
| 382 | - $file_dsply = ! empty($file) ? $file : ' '; |
|
| 383 | - $class_dsply = ! empty($class) ? $class : ' '; |
|
| 384 | - $type_dsply = ! empty($type) ? $type : ' '; |
|
| 385 | - $function_dsply = ! empty($function) ? $function : ' '; |
|
| 386 | - $args_dsply = ! empty($args) ? '( ' . $args . ' )' : ''; |
|
| 387 | - $trace_details .= ' |
|
| 356 | + $last_on_stack = count($ex['trace']) - 1; |
|
| 357 | + // reverse array so that stack is in proper chronological order |
|
| 358 | + $sorted_trace = array_reverse($ex['trace']); |
|
| 359 | + foreach ($sorted_trace as $nmbr => $trace) { |
|
| 360 | + $file = isset($trace['file']) ? $trace['file'] : ''; |
|
| 361 | + $class = isset($trace['class']) ? $trace['class'] : ''; |
|
| 362 | + $type = isset($trace['type']) ? $trace['type'] : ''; |
|
| 363 | + $function = isset($trace['function']) ? $trace['function'] : ''; |
|
| 364 | + $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : ''; |
|
| 365 | + $line = isset($trace['line']) ? $trace['line'] : ''; |
|
| 366 | + $zebra = ($nmbr % 2) ? ' odd' : ''; |
|
| 367 | + if (empty($file) && ! empty($class)) { |
|
| 368 | + $a = new ReflectionClass($class); |
|
| 369 | + $file = $a->getFileName(); |
|
| 370 | + if (empty($line) && ! empty($function)) { |
|
| 371 | + $b = new ReflectionMethod($class, $function); |
|
| 372 | + $line = $b->getStartLine(); |
|
| 373 | + } |
|
| 374 | + } |
|
| 375 | + if ($nmbr === $last_on_stack) { |
|
| 376 | + $file = $ex['file'] !== '' ? $ex['file'] : $file; |
|
| 377 | + $line = $ex['line'] !== '' ? $ex['line'] : $line; |
|
| 378 | + $error_code = self::generate_error_code($file, $trace['function'], $line); |
|
| 379 | + } |
|
| 380 | + $nmbr_dsply = ! empty($nmbr) ? $nmbr : ' '; |
|
| 381 | + $line_dsply = ! empty($line) ? $line : ' '; |
|
| 382 | + $file_dsply = ! empty($file) ? $file : ' '; |
|
| 383 | + $class_dsply = ! empty($class) ? $class : ' '; |
|
| 384 | + $type_dsply = ! empty($type) ? $type : ' '; |
|
| 385 | + $function_dsply = ! empty($function) ? $function : ' '; |
|
| 386 | + $args_dsply = ! empty($args) ? '( ' . $args . ' )' : ''; |
|
| 387 | + $trace_details .= ' |
|
| 388 | 388 | <tr> |
| 389 | 389 | <td align="right" class="' . $zebra . '">' . $nmbr_dsply . '</td> |
| 390 | 390 | <td align="right" class="' . $zebra . '">' . $line_dsply . '</td> |
@@ -392,674 +392,674 @@ discard block |
||
| 392 | 392 | <td align="left" class="' . $zebra . '">' . $class_dsply . '</td> |
| 393 | 393 | <td align="left" class="' . $zebra . '">' . $type_dsply . $function_dsply . $args_dsply . '</td> |
| 394 | 394 | </tr>'; |
| 395 | - } |
|
| 396 | - $trace_details .= ' |
|
| 395 | + } |
|
| 396 | + $trace_details .= ' |
|
| 397 | 397 | </table> |
| 398 | 398 | </div>'; |
| 399 | - } |
|
| 400 | - $ex['code'] = $ex['code'] ? $ex['code'] : $error_code; |
|
| 401 | - // add generic non-identifying messages for non-privileged users |
|
| 402 | - if (! WP_DEBUG) { |
|
| 403 | - $output .= '<span class="ee-error-user-msg-spn">' |
|
| 404 | - . trim($ex['msg']) |
|
| 405 | - . '</span> <sup>' |
|
| 406 | - . $ex['code'] |
|
| 407 | - . '</sup><br />'; |
|
| 408 | - } else { |
|
| 409 | - // or helpful developer messages if debugging is on |
|
| 410 | - $output .= ' |
|
| 399 | + } |
|
| 400 | + $ex['code'] = $ex['code'] ? $ex['code'] : $error_code; |
|
| 401 | + // add generic non-identifying messages for non-privileged users |
|
| 402 | + if (! WP_DEBUG) { |
|
| 403 | + $output .= '<span class="ee-error-user-msg-spn">' |
|
| 404 | + . trim($ex['msg']) |
|
| 405 | + . '</span> <sup>' |
|
| 406 | + . $ex['code'] |
|
| 407 | + . '</sup><br />'; |
|
| 408 | + } else { |
|
| 409 | + // or helpful developer messages if debugging is on |
|
| 410 | + $output .= ' |
|
| 411 | 411 | <div class="ee-error-dev-msg-dv"> |
| 412 | 412 | <p class="ee-error-dev-msg-pg"> |
| 413 | 413 | <strong class="ee-error-dev-msg-str">An ' |
| 414 | - . $ex['name'] |
|
| 415 | - . ' exception was thrown!</strong> <span>code: ' |
|
| 416 | - . $ex['code'] |
|
| 417 | - . '</span><br /> |
|
| 414 | + . $ex['name'] |
|
| 415 | + . ' exception was thrown!</strong> <span>code: ' |
|
| 416 | + . $ex['code'] |
|
| 417 | + . '</span><br /> |
|
| 418 | 418 | <span class="big-text">"' |
| 419 | - . trim($ex['msg']) |
|
| 420 | - . '"</span><br/> |
|
| 419 | + . trim($ex['msg']) |
|
| 420 | + . '"</span><br/> |
|
| 421 | 421 | <a id="display-ee-error-trace-' |
| 422 | - . self::$_error_count |
|
| 423 | - . $time |
|
| 424 | - . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-' |
|
| 425 | - . self::$_error_count |
|
| 426 | - . $time |
|
| 427 | - . '"> |
|
| 422 | + . self::$_error_count |
|
| 423 | + . $time |
|
| 424 | + . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-' |
|
| 425 | + . self::$_error_count |
|
| 426 | + . $time |
|
| 427 | + . '"> |
|
| 428 | 428 | ' |
| 429 | - . __('click to view backtrace and class/method details', 'event_espresso') |
|
| 430 | - . ' |
|
| 429 | + . __('click to view backtrace and class/method details', 'event_espresso') |
|
| 430 | + . ' |
|
| 431 | 431 | </a><br /> |
| 432 | 432 | <span class="small-text lt-grey-text">' |
| 433 | - . $ex['file'] |
|
| 434 | - . ' ( line no: ' |
|
| 435 | - . $ex['line'] |
|
| 436 | - . ' )</span> |
|
| 433 | + . $ex['file'] |
|
| 434 | + . ' ( line no: ' |
|
| 435 | + . $ex['line'] |
|
| 436 | + . ' )</span> |
|
| 437 | 437 | </p> |
| 438 | 438 | <div id="ee-error-trace-' |
| 439 | - . self::$_error_count |
|
| 440 | - . $time |
|
| 441 | - . '-dv" class="ee-error-trace-dv" style="display: none;"> |
|
| 439 | + . self::$_error_count |
|
| 440 | + . $time |
|
| 441 | + . '-dv" class="ee-error-trace-dv" style="display: none;"> |
|
| 442 | 442 | ' |
| 443 | - . $trace_details; |
|
| 444 | - if (! empty($class)) { |
|
| 445 | - $output .= ' |
|
| 443 | + . $trace_details; |
|
| 444 | + if (! empty($class)) { |
|
| 445 | + $output .= ' |
|
| 446 | 446 | <div style="padding:3px; margin:0 0 1em; border:1px solid #666; background:#fff; border-radius:3px;"> |
| 447 | 447 | <div style="padding:1em 2em; border:1px solid #666; background:#f9f9f9;"> |
| 448 | 448 | <h3>Class Details</h3>'; |
| 449 | - $a = new ReflectionClass($class); |
|
| 450 | - $output .= ' |
|
| 449 | + $a = new ReflectionClass($class); |
|
| 450 | + $output .= ' |
|
| 451 | 451 | <pre>' . $a . '</pre> |
| 452 | 452 | </div> |
| 453 | 453 | </div>'; |
| 454 | - } |
|
| 455 | - $output .= ' |
|
| 454 | + } |
|
| 455 | + $output .= ' |
|
| 456 | 456 | </div> |
| 457 | 457 | </div> |
| 458 | 458 | <br />'; |
| 459 | - } |
|
| 460 | - $this->write_to_error_log($time, $ex); |
|
| 461 | - } |
|
| 462 | - // remove last linebreak |
|
| 463 | - $output = substr($output, 0, -6); |
|
| 464 | - if (! WP_DEBUG) { |
|
| 465 | - $output .= ' |
|
| 459 | + } |
|
| 460 | + $this->write_to_error_log($time, $ex); |
|
| 461 | + } |
|
| 462 | + // remove last linebreak |
|
| 463 | + $output = substr($output, 0, -6); |
|
| 464 | + if (! WP_DEBUG) { |
|
| 465 | + $output .= ' |
|
| 466 | 466 | </p>'; |
| 467 | - } |
|
| 468 | - $output .= ' |
|
| 467 | + } |
|
| 468 | + $output .= ' |
|
| 469 | 469 | </div>'; |
| 470 | - $output .= self::_print_scripts(true); |
|
| 471 | - if (defined('DOING_AJAX')) { |
|
| 472 | - echo wp_json_encode(array('error' => $output)); |
|
| 473 | - exit(); |
|
| 474 | - } |
|
| 475 | - echo $output; |
|
| 476 | - die(); |
|
| 477 | - } |
|
| 478 | - |
|
| 479 | - |
|
| 480 | - |
|
| 481 | - /** |
|
| 482 | - * generate string from exception trace args |
|
| 483 | - * |
|
| 484 | - * @param array $arguments |
|
| 485 | - * @param bool $array |
|
| 486 | - * @return string |
|
| 487 | - */ |
|
| 488 | - private function _convert_args_to_string($arguments = array(), $array = false) |
|
| 489 | - { |
|
| 490 | - $arg_string = ''; |
|
| 491 | - if (! empty($arguments)) { |
|
| 492 | - $args = array(); |
|
| 493 | - foreach ($arguments as $arg) { |
|
| 494 | - if (! empty($arg)) { |
|
| 495 | - if (is_string($arg)) { |
|
| 496 | - $args[] = " '" . $arg . "'"; |
|
| 497 | - } elseif (is_array($arg)) { |
|
| 498 | - $args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true); |
|
| 499 | - } elseif ($arg === null) { |
|
| 500 | - $args[] = ' NULL'; |
|
| 501 | - } elseif (is_bool($arg)) { |
|
| 502 | - $args[] = ($arg) ? ' TRUE' : ' FALSE'; |
|
| 503 | - } elseif (is_object($arg)) { |
|
| 504 | - $args[] = ' OBJECT ' . get_class($arg); |
|
| 505 | - } elseif (is_resource($arg)) { |
|
| 506 | - $args[] = get_resource_type($arg); |
|
| 507 | - } else { |
|
| 508 | - $args[] = $arg; |
|
| 509 | - } |
|
| 510 | - } |
|
| 511 | - } |
|
| 512 | - $arg_string = implode(', ', $args); |
|
| 513 | - } |
|
| 514 | - if ($array) { |
|
| 515 | - $arg_string .= ' )'; |
|
| 516 | - } |
|
| 517 | - return $arg_string; |
|
| 518 | - } |
|
| 519 | - |
|
| 520 | - |
|
| 521 | - |
|
| 522 | - /** |
|
| 523 | - * add error message |
|
| 524 | - * |
|
| 525 | - * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates |
|
| 526 | - * separate messages for user || dev |
|
| 527 | - * @param string $file the file that the error occurred in - just use __FILE__ |
|
| 528 | - * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
| 529 | - * @param string $line the line number where the error occurred - just use __LINE__ |
|
| 530 | - * @return void |
|
| 531 | - */ |
|
| 532 | - public static function add_error($msg = null, $file = null, $func = null, $line = null) |
|
| 533 | - { |
|
| 534 | - self::_add_notice('errors', $msg, $file, $func, $line); |
|
| 535 | - self::$_error_count++; |
|
| 536 | - } |
|
| 537 | - |
|
| 538 | - |
|
| 539 | - |
|
| 540 | - /** |
|
| 541 | - * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just |
|
| 542 | - * adds an error |
|
| 543 | - * |
|
| 544 | - * @param string $msg |
|
| 545 | - * @param string $file |
|
| 546 | - * @param string $func |
|
| 547 | - * @param string $line |
|
| 548 | - * @throws EE_Error |
|
| 549 | - */ |
|
| 550 | - public static function throw_exception_if_debugging($msg = null, $file = null, $func = null, $line = null) |
|
| 551 | - { |
|
| 552 | - if (WP_DEBUG) { |
|
| 553 | - throw new EE_Error($msg); |
|
| 554 | - } |
|
| 555 | - EE_Error::add_error($msg, $file, $func, $line); |
|
| 556 | - } |
|
| 557 | - |
|
| 558 | - |
|
| 559 | - |
|
| 560 | - /** |
|
| 561 | - * add success message |
|
| 562 | - * |
|
| 563 | - * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates |
|
| 564 | - * separate messages for user || dev |
|
| 565 | - * @param string $file the file that the error occurred in - just use __FILE__ |
|
| 566 | - * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
| 567 | - * @param string $line the line number where the error occurred - just use __LINE__ |
|
| 568 | - * @return void |
|
| 569 | - */ |
|
| 570 | - public static function add_success($msg = null, $file = null, $func = null, $line = null) |
|
| 571 | - { |
|
| 572 | - self::_add_notice('success', $msg, $file, $func, $line); |
|
| 573 | - } |
|
| 574 | - |
|
| 575 | - |
|
| 576 | - |
|
| 577 | - /** |
|
| 578 | - * add attention message |
|
| 579 | - * |
|
| 580 | - * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates |
|
| 581 | - * separate messages for user || dev |
|
| 582 | - * @param string $file the file that the error occurred in - just use __FILE__ |
|
| 583 | - * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
| 584 | - * @param string $line the line number where the error occurred - just use __LINE__ |
|
| 585 | - * @return void |
|
| 586 | - */ |
|
| 587 | - public static function add_attention($msg = null, $file = null, $func = null, $line = null) |
|
| 588 | - { |
|
| 589 | - self::_add_notice('attention', $msg, $file, $func, $line); |
|
| 590 | - } |
|
| 591 | - |
|
| 592 | - |
|
| 593 | - |
|
| 594 | - /** |
|
| 595 | - * add success message |
|
| 596 | - * |
|
| 597 | - * @param string $type whether the message is for a success or error notification |
|
| 598 | - * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates |
|
| 599 | - * separate messages for user || dev |
|
| 600 | - * @param string $file the file that the error occurred in - just use __FILE__ |
|
| 601 | - * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
| 602 | - * @param string $line the line number where the error occurred - just use __LINE__ |
|
| 603 | - * @return void |
|
| 604 | - */ |
|
| 605 | - private static function _add_notice($type = 'success', $msg = null, $file = null, $func = null, $line = null) |
|
| 606 | - { |
|
| 607 | - if (empty($msg)) { |
|
| 608 | - EE_Error::doing_it_wrong( |
|
| 609 | - 'EE_Error::add_' . $type . '()', |
|
| 610 | - sprintf( |
|
| 611 | - __('Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d', |
|
| 612 | - 'event_espresso'), |
|
| 613 | - $type, |
|
| 614 | - $file, |
|
| 615 | - $line |
|
| 616 | - ), |
|
| 617 | - EVENT_ESPRESSO_VERSION |
|
| 618 | - ); |
|
| 619 | - } |
|
| 620 | - if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) { |
|
| 621 | - EE_Error::doing_it_wrong( |
|
| 622 | - 'EE_Error::add_error()', |
|
| 623 | - __('You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.', |
|
| 624 | - 'event_espresso'), |
|
| 625 | - EVENT_ESPRESSO_VERSION |
|
| 626 | - ); |
|
| 627 | - } |
|
| 628 | - // get separate user and developer messages if they exist |
|
| 629 | - $msg = explode('||', $msg); |
|
| 630 | - $user_msg = $msg[0]; |
|
| 631 | - $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0]; |
|
| 632 | - /** |
|
| 633 | - * Do an action so other code can be triggered when a notice is created |
|
| 634 | - * |
|
| 635 | - * @param string $type can be 'errors', 'attention', or 'success' |
|
| 636 | - * @param string $user_msg message displayed to user when WP_DEBUG is off |
|
| 637 | - * @param string $user_msg message displayed to user when WP_DEBUG is on |
|
| 638 | - * @param string $file file where error was generated |
|
| 639 | - * @param string $func function where error was generated |
|
| 640 | - * @param string $line line where error was generated |
|
| 641 | - */ |
|
| 642 | - do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line); |
|
| 643 | - $msg = WP_DEBUG ? $dev_msg : $user_msg; |
|
| 644 | - // add notice if message exists |
|
| 645 | - if (! empty($msg)) { |
|
| 646 | - // get error code |
|
| 647 | - $notice_code = EE_Error::generate_error_code($file, $func, $line); |
|
| 648 | - if (WP_DEBUG && $type === 'errors') { |
|
| 649 | - $msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>'; |
|
| 650 | - } |
|
| 651 | - // add notice. Index by code if it's not blank |
|
| 652 | - if ($notice_code) { |
|
| 653 | - self::$_espresso_notices[$type][$notice_code] = $msg; |
|
| 654 | - } else { |
|
| 655 | - self::$_espresso_notices[$type][] = $msg; |
|
| 656 | - } |
|
| 657 | - add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1); |
|
| 658 | - } |
|
| 659 | - } |
|
| 660 | - |
|
| 661 | - |
|
| 662 | - |
|
| 663 | - /** |
|
| 664 | - * in some case it may be necessary to overwrite the existing success messages |
|
| 665 | - * |
|
| 666 | - * @return void |
|
| 667 | - */ |
|
| 668 | - public static function overwrite_success() |
|
| 669 | - { |
|
| 670 | - self::$_espresso_notices['success'] = false; |
|
| 671 | - } |
|
| 672 | - |
|
| 673 | - |
|
| 674 | - |
|
| 675 | - /** |
|
| 676 | - * in some case it may be necessary to overwrite the existing attention messages |
|
| 677 | - * |
|
| 678 | - * @return void |
|
| 679 | - */ |
|
| 680 | - public static function overwrite_attention() |
|
| 681 | - { |
|
| 682 | - self::$_espresso_notices['attention'] = false; |
|
| 683 | - } |
|
| 684 | - |
|
| 685 | - |
|
| 686 | - |
|
| 687 | - /** |
|
| 688 | - * in some case it may be necessary to overwrite the existing error messages |
|
| 689 | - * |
|
| 690 | - * @return void |
|
| 691 | - */ |
|
| 692 | - public static function overwrite_errors() |
|
| 693 | - { |
|
| 694 | - self::$_espresso_notices['errors'] = false; |
|
| 695 | - } |
|
| 696 | - |
|
| 697 | - |
|
| 698 | - |
|
| 699 | - /** |
|
| 700 | - * reset_notices |
|
| 701 | - * |
|
| 702 | - * @return void |
|
| 703 | - */ |
|
| 704 | - public static function reset_notices() |
|
| 705 | - { |
|
| 706 | - self::$_espresso_notices['success'] = false; |
|
| 707 | - self::$_espresso_notices['attention'] = false; |
|
| 708 | - self::$_espresso_notices['errors'] = false; |
|
| 709 | - } |
|
| 710 | - |
|
| 711 | - |
|
| 712 | - |
|
| 713 | - /** |
|
| 714 | - * has_errors |
|
| 715 | - * |
|
| 716 | - * @return int |
|
| 717 | - */ |
|
| 718 | - public static function has_notices() |
|
| 719 | - { |
|
| 720 | - $has_notices = 0; |
|
| 721 | - // check for success messages |
|
| 722 | - $has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success']) ? 3 |
|
| 723 | - : $has_notices; |
|
| 724 | - // check for attention messages |
|
| 725 | - $has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention']) ? 2 |
|
| 726 | - : $has_notices; |
|
| 727 | - // check for error messages |
|
| 728 | - $has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors']) ? 1 |
|
| 729 | - : $has_notices; |
|
| 730 | - return $has_notices; |
|
| 731 | - } |
|
| 732 | - |
|
| 733 | - |
|
| 734 | - |
|
| 735 | - /** |
|
| 736 | - * This simply returns non formatted error notices as they were sent into the EE_Error object. |
|
| 737 | - * |
|
| 738 | - * @since 4.9.0 |
|
| 739 | - * @return array |
|
| 740 | - */ |
|
| 741 | - public static function get_vanilla_notices() |
|
| 742 | - { |
|
| 743 | - return array( |
|
| 744 | - 'success' => isset(self::$_espresso_notices['success']) ? self::$_espresso_notices['success'] : array(), |
|
| 745 | - 'attention' => isset(self::$_espresso_notices['attention']) ? self::$_espresso_notices['attention'] |
|
| 746 | - : array(), |
|
| 747 | - 'errors' => isset(self::$_espresso_notices['errors']) ? self::$_espresso_notices['errors'] : array(), |
|
| 748 | - ); |
|
| 749 | - } |
|
| 750 | - |
|
| 751 | - |
|
| 752 | - |
|
| 753 | - /** |
|
| 754 | - * compile all error or success messages into one string |
|
| 755 | - * |
|
| 756 | - * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them |
|
| 757 | - * @param boolean $format_output whether or not to format the messages for display in the WP admin |
|
| 758 | - * @param boolean $save_to_transient whether or not to save notices to the db for retrieval on next request |
|
| 759 | - * - ONLY do this just before redirecting |
|
| 760 | - * @param boolean $remove_empty whether or not to unset empty messages |
|
| 761 | - * @return array |
|
| 762 | - */ |
|
| 763 | - public static function get_notices($format_output = true, $save_to_transient = false, $remove_empty = true) |
|
| 764 | - { |
|
| 765 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 766 | - $success_messages = ''; |
|
| 767 | - $attention_messages = ''; |
|
| 768 | - $error_messages = ''; |
|
| 769 | - $print_scripts = false; |
|
| 770 | - // either save notices to the db |
|
| 771 | - if ($save_to_transient) { |
|
| 772 | - update_option('ee_notices', self::$_espresso_notices); |
|
| 773 | - return array(); |
|
| 774 | - } |
|
| 775 | - // grab any notices that have been previously saved |
|
| 776 | - if ($notices = get_option('ee_notices', false)) { |
|
| 777 | - foreach ($notices as $type => $notice) { |
|
| 778 | - if (is_array($notice) && ! empty($notice)) { |
|
| 779 | - // make sure that existing notice type is an array |
|
| 780 | - self::$_espresso_notices[$type] = is_array(self::$_espresso_notices[$type]) |
|
| 781 | - && ! empty(self::$_espresso_notices[$type]) |
|
| 782 | - ? self::$_espresso_notices[$type] : array(); |
|
| 783 | - // merge stored notices with any newly created ones |
|
| 784 | - self::$_espresso_notices[$type] = array_merge(self::$_espresso_notices[$type], $notice); |
|
| 785 | - $print_scripts = true; |
|
| 786 | - } |
|
| 787 | - } |
|
| 788 | - // now clear any stored notices |
|
| 789 | - update_option('ee_notices', false); |
|
| 790 | - } |
|
| 791 | - // check for success messages |
|
| 792 | - if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) { |
|
| 793 | - // combine messages |
|
| 794 | - $success_messages .= implode(self::$_espresso_notices['success'], '<br /><br />'); |
|
| 795 | - $print_scripts = true; |
|
| 796 | - } |
|
| 797 | - // check for attention messages |
|
| 798 | - if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) { |
|
| 799 | - // combine messages |
|
| 800 | - $attention_messages .= implode(self::$_espresso_notices['attention'], '<br /><br />'); |
|
| 801 | - $print_scripts = true; |
|
| 802 | - } |
|
| 803 | - // check for error messages |
|
| 804 | - if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) { |
|
| 805 | - $error_messages .= count(self::$_espresso_notices['errors']) > 1 |
|
| 806 | - ? __('The following errors have occurred:<br />', 'event_espresso') |
|
| 807 | - : __('An error has occurred:<br />', 'event_espresso'); |
|
| 808 | - // combine messages |
|
| 809 | - $error_messages .= implode(self::$_espresso_notices['errors'], '<br /><br />'); |
|
| 810 | - $print_scripts = true; |
|
| 811 | - } |
|
| 812 | - if ($format_output) { |
|
| 813 | - $notices = '<div id="espresso-notices">'; |
|
| 814 | - $close = is_admin() ? '' |
|
| 815 | - : '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"></span></a>'; |
|
| 816 | - if ($success_messages !== '') { |
|
| 817 | - $css_id = is_admin() ? 'message' : 'espresso-notices-success'; |
|
| 818 | - $css_class = is_admin() ? 'updated fade' : 'success fade-away'; |
|
| 819 | - //showMessage( $success_messages ); |
|
| 820 | - $notices .= '<div id="' |
|
| 821 | - . $css_id |
|
| 822 | - . '" class="espresso-notices ' |
|
| 823 | - . $css_class |
|
| 824 | - . '" style="display:none;"><p>' |
|
| 825 | - . $success_messages |
|
| 826 | - . '</p>' |
|
| 827 | - . $close |
|
| 828 | - . '</div>'; |
|
| 829 | - } |
|
| 830 | - if ($attention_messages !== '') { |
|
| 831 | - $css_id = is_admin() ? 'message' : 'espresso-notices-attention'; |
|
| 832 | - $css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away'; |
|
| 833 | - //showMessage( $error_messages, TRUE ); |
|
| 834 | - $notices .= '<div id="' |
|
| 835 | - . $css_id |
|
| 836 | - . '" class="espresso-notices ' |
|
| 837 | - . $css_class |
|
| 838 | - . '" style="display:none;"><p>' |
|
| 839 | - . $attention_messages |
|
| 840 | - . '</p>' |
|
| 841 | - . $close |
|
| 842 | - . '</div>'; |
|
| 843 | - } |
|
| 844 | - if ($error_messages !== '') { |
|
| 845 | - $css_id = is_admin() ? 'message' : 'espresso-notices-error'; |
|
| 846 | - $css_class = is_admin() ? 'error' : 'error fade-away'; |
|
| 847 | - //showMessage( $error_messages, TRUE ); |
|
| 848 | - $notices .= '<div id="' |
|
| 849 | - . $css_id |
|
| 850 | - . '" class="espresso-notices ' |
|
| 851 | - . $css_class |
|
| 852 | - . '" style="display:none;"><p>' |
|
| 853 | - . $error_messages |
|
| 854 | - . '</p>' |
|
| 855 | - . $close |
|
| 856 | - . '</div>'; |
|
| 857 | - } |
|
| 858 | - $notices .= '</div>'; |
|
| 859 | - } else { |
|
| 860 | - $notices = array( |
|
| 861 | - 'success' => $success_messages, |
|
| 862 | - 'attention' => $attention_messages, |
|
| 863 | - 'errors' => $error_messages, |
|
| 864 | - ); |
|
| 865 | - if ($remove_empty) { |
|
| 866 | - // remove empty notices |
|
| 867 | - foreach ($notices as $type => $notice) { |
|
| 868 | - if (empty($notice)) { |
|
| 869 | - unset($notices[$type]); |
|
| 870 | - } |
|
| 871 | - } |
|
| 872 | - } |
|
| 873 | - } |
|
| 874 | - if ($print_scripts) { |
|
| 875 | - self::_print_scripts(); |
|
| 876 | - } |
|
| 877 | - return $notices; |
|
| 878 | - } |
|
| 879 | - |
|
| 880 | - |
|
| 881 | - |
|
| 882 | - /** |
|
| 883 | - * add_persistent_admin_notice |
|
| 884 | - * |
|
| 885 | - * @param string $pan_name the name, or key of the Persistent Admin Notice to be stored |
|
| 886 | - * @param string $pan_message the message to be stored persistently until dismissed |
|
| 887 | - * @param bool $force_update allows one to enforce the reappearance of a persistent message. |
|
| 888 | - * @return void |
|
| 889 | - */ |
|
| 890 | - public static function add_persistent_admin_notice($pan_name = '', $pan_message, $force_update = false) |
|
| 891 | - { |
|
| 892 | - if (! empty($pan_name) && ! empty($pan_message)) { |
|
| 893 | - $persistent_admin_notices = get_option('ee_pers_admin_notices', array()); |
|
| 894 | - //maybe initialize persistent_admin_notices |
|
| 895 | - if (empty($persistent_admin_notices)) { |
|
| 896 | - add_option('ee_pers_admin_notices', array(), '', 'no'); |
|
| 897 | - } |
|
| 898 | - $pan_name = sanitize_key($pan_name); |
|
| 899 | - if (! array_key_exists($pan_name, $persistent_admin_notices) || $force_update) { |
|
| 900 | - $persistent_admin_notices[$pan_name] = $pan_message; |
|
| 901 | - update_option('ee_pers_admin_notices', $persistent_admin_notices); |
|
| 902 | - } |
|
| 903 | - } |
|
| 904 | - } |
|
| 905 | - |
|
| 906 | - |
|
| 907 | - |
|
| 908 | - /** |
|
| 909 | - * dismiss_persistent_admin_notice |
|
| 910 | - * |
|
| 911 | - * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed |
|
| 912 | - * @param bool $purge |
|
| 913 | - * @param bool $return_immediately |
|
| 914 | - * @return void |
|
| 915 | - */ |
|
| 916 | - public static function dismiss_persistent_admin_notice($pan_name = '', $purge = false, $return_immediately = false) |
|
| 917 | - { |
|
| 918 | - $pan_name = EE_Registry::instance()->REQ->is_set('ee_nag_notice') |
|
| 919 | - ? EE_Registry::instance()->REQ->get('ee_nag_notice') : $pan_name; |
|
| 920 | - if (! empty($pan_name)) { |
|
| 921 | - $persistent_admin_notices = get_option('ee_pers_admin_notices', array()); |
|
| 922 | - // check if notice we wish to dismiss is actually in the $persistent_admin_notices array |
|
| 923 | - if (is_array($persistent_admin_notices) && isset($persistent_admin_notices[$pan_name])) { |
|
| 924 | - // completely delete nag notice, or just NULL message so that it can NOT be added again ? |
|
| 925 | - if ($purge) { |
|
| 926 | - unset($persistent_admin_notices[$pan_name]); |
|
| 927 | - } else { |
|
| 928 | - $persistent_admin_notices[$pan_name] = null; |
|
| 929 | - } |
|
| 930 | - if (update_option('ee_pers_admin_notices', $persistent_admin_notices) === false) { |
|
| 931 | - EE_Error::add_error(sprintf(__('The persistent admin notice for "%s" could not be deleted.', |
|
| 932 | - 'event_espresso'), $pan_name), __FILE__, __FUNCTION__, __LINE__); |
|
| 933 | - } |
|
| 934 | - } |
|
| 935 | - } |
|
| 936 | - if ($return_immediately) { |
|
| 937 | - return; |
|
| 938 | - } |
|
| 939 | - if (EE_Registry::instance()->REQ->ajax) { |
|
| 940 | - // grab any notices and concatenate into string |
|
| 941 | - echo wp_json_encode(array('errors' => implode('<br />', EE_Error::get_notices(false)))); |
|
| 942 | - exit(); |
|
| 943 | - } |
|
| 944 | - // save errors to a transient to be displayed on next request (after redirect) |
|
| 945 | - EE_Error::get_notices(false, true); |
|
| 946 | - $return_url = EE_Registry::instance()->REQ->is_set('return_url') |
|
| 947 | - ? EE_Registry::instance()->REQ->get('return_url') : ''; |
|
| 948 | - wp_safe_redirect(urldecode($return_url)); |
|
| 949 | - } |
|
| 950 | - |
|
| 951 | - |
|
| 952 | - |
|
| 953 | - /** |
|
| 954 | - * display_persistent_admin_notices |
|
| 955 | - * |
|
| 956 | - * @param string $pan_name the name, or key of the Persistent Admin Notice to be stored |
|
| 957 | - * @param string $pan_message the message to be stored persistently until dismissed |
|
| 958 | - * @param string $return_url URL to go back to after nag notice is dismissed |
|
| 959 | - * @return string |
|
| 960 | - */ |
|
| 961 | - public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '') |
|
| 962 | - { |
|
| 963 | - if (! empty($pan_name) && ! empty($pan_message)) { |
|
| 964 | - $args = array( |
|
| 965 | - 'nag_notice' => $pan_name, |
|
| 966 | - 'return_url' => urlencode($return_url), |
|
| 967 | - 'ajax_url' => WP_AJAX_URL, |
|
| 968 | - 'unknown_error' => esc_html__( |
|
| 969 | - 'An unknown error has occurred on the server while attempting to dismiss this notice.', |
|
| 970 | - 'event_espresso' |
|
| 971 | - ), |
|
| 972 | - ); |
|
| 973 | - EE_Registry::$i18n_js_strings = array_merge( |
|
| 974 | - EE_Registry::$i18n_js_strings, |
|
| 975 | - array('ee_dismiss' => $args) |
|
| 976 | - ); |
|
| 977 | - return ' |
|
| 470 | + $output .= self::_print_scripts(true); |
|
| 471 | + if (defined('DOING_AJAX')) { |
|
| 472 | + echo wp_json_encode(array('error' => $output)); |
|
| 473 | + exit(); |
|
| 474 | + } |
|
| 475 | + echo $output; |
|
| 476 | + die(); |
|
| 477 | + } |
|
| 478 | + |
|
| 479 | + |
|
| 480 | + |
|
| 481 | + /** |
|
| 482 | + * generate string from exception trace args |
|
| 483 | + * |
|
| 484 | + * @param array $arguments |
|
| 485 | + * @param bool $array |
|
| 486 | + * @return string |
|
| 487 | + */ |
|
| 488 | + private function _convert_args_to_string($arguments = array(), $array = false) |
|
| 489 | + { |
|
| 490 | + $arg_string = ''; |
|
| 491 | + if (! empty($arguments)) { |
|
| 492 | + $args = array(); |
|
| 493 | + foreach ($arguments as $arg) { |
|
| 494 | + if (! empty($arg)) { |
|
| 495 | + if (is_string($arg)) { |
|
| 496 | + $args[] = " '" . $arg . "'"; |
|
| 497 | + } elseif (is_array($arg)) { |
|
| 498 | + $args[] = 'ARRAY(' . $this->_convert_args_to_string($arg, true); |
|
| 499 | + } elseif ($arg === null) { |
|
| 500 | + $args[] = ' NULL'; |
|
| 501 | + } elseif (is_bool($arg)) { |
|
| 502 | + $args[] = ($arg) ? ' TRUE' : ' FALSE'; |
|
| 503 | + } elseif (is_object($arg)) { |
|
| 504 | + $args[] = ' OBJECT ' . get_class($arg); |
|
| 505 | + } elseif (is_resource($arg)) { |
|
| 506 | + $args[] = get_resource_type($arg); |
|
| 507 | + } else { |
|
| 508 | + $args[] = $arg; |
|
| 509 | + } |
|
| 510 | + } |
|
| 511 | + } |
|
| 512 | + $arg_string = implode(', ', $args); |
|
| 513 | + } |
|
| 514 | + if ($array) { |
|
| 515 | + $arg_string .= ' )'; |
|
| 516 | + } |
|
| 517 | + return $arg_string; |
|
| 518 | + } |
|
| 519 | + |
|
| 520 | + |
|
| 521 | + |
|
| 522 | + /** |
|
| 523 | + * add error message |
|
| 524 | + * |
|
| 525 | + * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates |
|
| 526 | + * separate messages for user || dev |
|
| 527 | + * @param string $file the file that the error occurred in - just use __FILE__ |
|
| 528 | + * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
| 529 | + * @param string $line the line number where the error occurred - just use __LINE__ |
|
| 530 | + * @return void |
|
| 531 | + */ |
|
| 532 | + public static function add_error($msg = null, $file = null, $func = null, $line = null) |
|
| 533 | + { |
|
| 534 | + self::_add_notice('errors', $msg, $file, $func, $line); |
|
| 535 | + self::$_error_count++; |
|
| 536 | + } |
|
| 537 | + |
|
| 538 | + |
|
| 539 | + |
|
| 540 | + /** |
|
| 541 | + * If WP_DEBUG is active, throws an exception. If WP_DEBUG is off, just |
|
| 542 | + * adds an error |
|
| 543 | + * |
|
| 544 | + * @param string $msg |
|
| 545 | + * @param string $file |
|
| 546 | + * @param string $func |
|
| 547 | + * @param string $line |
|
| 548 | + * @throws EE_Error |
|
| 549 | + */ |
|
| 550 | + public static function throw_exception_if_debugging($msg = null, $file = null, $func = null, $line = null) |
|
| 551 | + { |
|
| 552 | + if (WP_DEBUG) { |
|
| 553 | + throw new EE_Error($msg); |
|
| 554 | + } |
|
| 555 | + EE_Error::add_error($msg, $file, $func, $line); |
|
| 556 | + } |
|
| 557 | + |
|
| 558 | + |
|
| 559 | + |
|
| 560 | + /** |
|
| 561 | + * add success message |
|
| 562 | + * |
|
| 563 | + * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates |
|
| 564 | + * separate messages for user || dev |
|
| 565 | + * @param string $file the file that the error occurred in - just use __FILE__ |
|
| 566 | + * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
| 567 | + * @param string $line the line number where the error occurred - just use __LINE__ |
|
| 568 | + * @return void |
|
| 569 | + */ |
|
| 570 | + public static function add_success($msg = null, $file = null, $func = null, $line = null) |
|
| 571 | + { |
|
| 572 | + self::_add_notice('success', $msg, $file, $func, $line); |
|
| 573 | + } |
|
| 574 | + |
|
| 575 | + |
|
| 576 | + |
|
| 577 | + /** |
|
| 578 | + * add attention message |
|
| 579 | + * |
|
| 580 | + * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates |
|
| 581 | + * separate messages for user || dev |
|
| 582 | + * @param string $file the file that the error occurred in - just use __FILE__ |
|
| 583 | + * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
| 584 | + * @param string $line the line number where the error occurred - just use __LINE__ |
|
| 585 | + * @return void |
|
| 586 | + */ |
|
| 587 | + public static function add_attention($msg = null, $file = null, $func = null, $line = null) |
|
| 588 | + { |
|
| 589 | + self::_add_notice('attention', $msg, $file, $func, $line); |
|
| 590 | + } |
|
| 591 | + |
|
| 592 | + |
|
| 593 | + |
|
| 594 | + /** |
|
| 595 | + * add success message |
|
| 596 | + * |
|
| 597 | + * @param string $type whether the message is for a success or error notification |
|
| 598 | + * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates |
|
| 599 | + * separate messages for user || dev |
|
| 600 | + * @param string $file the file that the error occurred in - just use __FILE__ |
|
| 601 | + * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
| 602 | + * @param string $line the line number where the error occurred - just use __LINE__ |
|
| 603 | + * @return void |
|
| 604 | + */ |
|
| 605 | + private static function _add_notice($type = 'success', $msg = null, $file = null, $func = null, $line = null) |
|
| 606 | + { |
|
| 607 | + if (empty($msg)) { |
|
| 608 | + EE_Error::doing_it_wrong( |
|
| 609 | + 'EE_Error::add_' . $type . '()', |
|
| 610 | + sprintf( |
|
| 611 | + __('Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d', |
|
| 612 | + 'event_espresso'), |
|
| 613 | + $type, |
|
| 614 | + $file, |
|
| 615 | + $line |
|
| 616 | + ), |
|
| 617 | + EVENT_ESPRESSO_VERSION |
|
| 618 | + ); |
|
| 619 | + } |
|
| 620 | + if ($type === 'errors' && (empty($file) || empty($func) || empty($line))) { |
|
| 621 | + EE_Error::doing_it_wrong( |
|
| 622 | + 'EE_Error::add_error()', |
|
| 623 | + __('You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.', |
|
| 624 | + 'event_espresso'), |
|
| 625 | + EVENT_ESPRESSO_VERSION |
|
| 626 | + ); |
|
| 627 | + } |
|
| 628 | + // get separate user and developer messages if they exist |
|
| 629 | + $msg = explode('||', $msg); |
|
| 630 | + $user_msg = $msg[0]; |
|
| 631 | + $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0]; |
|
| 632 | + /** |
|
| 633 | + * Do an action so other code can be triggered when a notice is created |
|
| 634 | + * |
|
| 635 | + * @param string $type can be 'errors', 'attention', or 'success' |
|
| 636 | + * @param string $user_msg message displayed to user when WP_DEBUG is off |
|
| 637 | + * @param string $user_msg message displayed to user when WP_DEBUG is on |
|
| 638 | + * @param string $file file where error was generated |
|
| 639 | + * @param string $func function where error was generated |
|
| 640 | + * @param string $line line where error was generated |
|
| 641 | + */ |
|
| 642 | + do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line); |
|
| 643 | + $msg = WP_DEBUG ? $dev_msg : $user_msg; |
|
| 644 | + // add notice if message exists |
|
| 645 | + if (! empty($msg)) { |
|
| 646 | + // get error code |
|
| 647 | + $notice_code = EE_Error::generate_error_code($file, $func, $line); |
|
| 648 | + if (WP_DEBUG && $type === 'errors') { |
|
| 649 | + $msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>'; |
|
| 650 | + } |
|
| 651 | + // add notice. Index by code if it's not blank |
|
| 652 | + if ($notice_code) { |
|
| 653 | + self::$_espresso_notices[$type][$notice_code] = $msg; |
|
| 654 | + } else { |
|
| 655 | + self::$_espresso_notices[$type][] = $msg; |
|
| 656 | + } |
|
| 657 | + add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1); |
|
| 658 | + } |
|
| 659 | + } |
|
| 660 | + |
|
| 661 | + |
|
| 662 | + |
|
| 663 | + /** |
|
| 664 | + * in some case it may be necessary to overwrite the existing success messages |
|
| 665 | + * |
|
| 666 | + * @return void |
|
| 667 | + */ |
|
| 668 | + public static function overwrite_success() |
|
| 669 | + { |
|
| 670 | + self::$_espresso_notices['success'] = false; |
|
| 671 | + } |
|
| 672 | + |
|
| 673 | + |
|
| 674 | + |
|
| 675 | + /** |
|
| 676 | + * in some case it may be necessary to overwrite the existing attention messages |
|
| 677 | + * |
|
| 678 | + * @return void |
|
| 679 | + */ |
|
| 680 | + public static function overwrite_attention() |
|
| 681 | + { |
|
| 682 | + self::$_espresso_notices['attention'] = false; |
|
| 683 | + } |
|
| 684 | + |
|
| 685 | + |
|
| 686 | + |
|
| 687 | + /** |
|
| 688 | + * in some case it may be necessary to overwrite the existing error messages |
|
| 689 | + * |
|
| 690 | + * @return void |
|
| 691 | + */ |
|
| 692 | + public static function overwrite_errors() |
|
| 693 | + { |
|
| 694 | + self::$_espresso_notices['errors'] = false; |
|
| 695 | + } |
|
| 696 | + |
|
| 697 | + |
|
| 698 | + |
|
| 699 | + /** |
|
| 700 | + * reset_notices |
|
| 701 | + * |
|
| 702 | + * @return void |
|
| 703 | + */ |
|
| 704 | + public static function reset_notices() |
|
| 705 | + { |
|
| 706 | + self::$_espresso_notices['success'] = false; |
|
| 707 | + self::$_espresso_notices['attention'] = false; |
|
| 708 | + self::$_espresso_notices['errors'] = false; |
|
| 709 | + } |
|
| 710 | + |
|
| 711 | + |
|
| 712 | + |
|
| 713 | + /** |
|
| 714 | + * has_errors |
|
| 715 | + * |
|
| 716 | + * @return int |
|
| 717 | + */ |
|
| 718 | + public static function has_notices() |
|
| 719 | + { |
|
| 720 | + $has_notices = 0; |
|
| 721 | + // check for success messages |
|
| 722 | + $has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success']) ? 3 |
|
| 723 | + : $has_notices; |
|
| 724 | + // check for attention messages |
|
| 725 | + $has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention']) ? 2 |
|
| 726 | + : $has_notices; |
|
| 727 | + // check for error messages |
|
| 728 | + $has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors']) ? 1 |
|
| 729 | + : $has_notices; |
|
| 730 | + return $has_notices; |
|
| 731 | + } |
|
| 732 | + |
|
| 733 | + |
|
| 734 | + |
|
| 735 | + /** |
|
| 736 | + * This simply returns non formatted error notices as they were sent into the EE_Error object. |
|
| 737 | + * |
|
| 738 | + * @since 4.9.0 |
|
| 739 | + * @return array |
|
| 740 | + */ |
|
| 741 | + public static function get_vanilla_notices() |
|
| 742 | + { |
|
| 743 | + return array( |
|
| 744 | + 'success' => isset(self::$_espresso_notices['success']) ? self::$_espresso_notices['success'] : array(), |
|
| 745 | + 'attention' => isset(self::$_espresso_notices['attention']) ? self::$_espresso_notices['attention'] |
|
| 746 | + : array(), |
|
| 747 | + 'errors' => isset(self::$_espresso_notices['errors']) ? self::$_espresso_notices['errors'] : array(), |
|
| 748 | + ); |
|
| 749 | + } |
|
| 750 | + |
|
| 751 | + |
|
| 752 | + |
|
| 753 | + /** |
|
| 754 | + * compile all error or success messages into one string |
|
| 755 | + * |
|
| 756 | + * @see EE_Error::get_raw_notices if you want the raw notices without any preparations made to them |
|
| 757 | + * @param boolean $format_output whether or not to format the messages for display in the WP admin |
|
| 758 | + * @param boolean $save_to_transient whether or not to save notices to the db for retrieval on next request |
|
| 759 | + * - ONLY do this just before redirecting |
|
| 760 | + * @param boolean $remove_empty whether or not to unset empty messages |
|
| 761 | + * @return array |
|
| 762 | + */ |
|
| 763 | + public static function get_notices($format_output = true, $save_to_transient = false, $remove_empty = true) |
|
| 764 | + { |
|
| 765 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
| 766 | + $success_messages = ''; |
|
| 767 | + $attention_messages = ''; |
|
| 768 | + $error_messages = ''; |
|
| 769 | + $print_scripts = false; |
|
| 770 | + // either save notices to the db |
|
| 771 | + if ($save_to_transient) { |
|
| 772 | + update_option('ee_notices', self::$_espresso_notices); |
|
| 773 | + return array(); |
|
| 774 | + } |
|
| 775 | + // grab any notices that have been previously saved |
|
| 776 | + if ($notices = get_option('ee_notices', false)) { |
|
| 777 | + foreach ($notices as $type => $notice) { |
|
| 778 | + if (is_array($notice) && ! empty($notice)) { |
|
| 779 | + // make sure that existing notice type is an array |
|
| 780 | + self::$_espresso_notices[$type] = is_array(self::$_espresso_notices[$type]) |
|
| 781 | + && ! empty(self::$_espresso_notices[$type]) |
|
| 782 | + ? self::$_espresso_notices[$type] : array(); |
|
| 783 | + // merge stored notices with any newly created ones |
|
| 784 | + self::$_espresso_notices[$type] = array_merge(self::$_espresso_notices[$type], $notice); |
|
| 785 | + $print_scripts = true; |
|
| 786 | + } |
|
| 787 | + } |
|
| 788 | + // now clear any stored notices |
|
| 789 | + update_option('ee_notices', false); |
|
| 790 | + } |
|
| 791 | + // check for success messages |
|
| 792 | + if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) { |
|
| 793 | + // combine messages |
|
| 794 | + $success_messages .= implode(self::$_espresso_notices['success'], '<br /><br />'); |
|
| 795 | + $print_scripts = true; |
|
| 796 | + } |
|
| 797 | + // check for attention messages |
|
| 798 | + if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) { |
|
| 799 | + // combine messages |
|
| 800 | + $attention_messages .= implode(self::$_espresso_notices['attention'], '<br /><br />'); |
|
| 801 | + $print_scripts = true; |
|
| 802 | + } |
|
| 803 | + // check for error messages |
|
| 804 | + if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) { |
|
| 805 | + $error_messages .= count(self::$_espresso_notices['errors']) > 1 |
|
| 806 | + ? __('The following errors have occurred:<br />', 'event_espresso') |
|
| 807 | + : __('An error has occurred:<br />', 'event_espresso'); |
|
| 808 | + // combine messages |
|
| 809 | + $error_messages .= implode(self::$_espresso_notices['errors'], '<br /><br />'); |
|
| 810 | + $print_scripts = true; |
|
| 811 | + } |
|
| 812 | + if ($format_output) { |
|
| 813 | + $notices = '<div id="espresso-notices">'; |
|
| 814 | + $close = is_admin() ? '' |
|
| 815 | + : '<a class="close-espresso-notice hide-if-no-js"><span class="dashicons dashicons-no"></span></a>'; |
|
| 816 | + if ($success_messages !== '') { |
|
| 817 | + $css_id = is_admin() ? 'message' : 'espresso-notices-success'; |
|
| 818 | + $css_class = is_admin() ? 'updated fade' : 'success fade-away'; |
|
| 819 | + //showMessage( $success_messages ); |
|
| 820 | + $notices .= '<div id="' |
|
| 821 | + . $css_id |
|
| 822 | + . '" class="espresso-notices ' |
|
| 823 | + . $css_class |
|
| 824 | + . '" style="display:none;"><p>' |
|
| 825 | + . $success_messages |
|
| 826 | + . '</p>' |
|
| 827 | + . $close |
|
| 828 | + . '</div>'; |
|
| 829 | + } |
|
| 830 | + if ($attention_messages !== '') { |
|
| 831 | + $css_id = is_admin() ? 'message' : 'espresso-notices-attention'; |
|
| 832 | + $css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away'; |
|
| 833 | + //showMessage( $error_messages, TRUE ); |
|
| 834 | + $notices .= '<div id="' |
|
| 835 | + . $css_id |
|
| 836 | + . '" class="espresso-notices ' |
|
| 837 | + . $css_class |
|
| 838 | + . '" style="display:none;"><p>' |
|
| 839 | + . $attention_messages |
|
| 840 | + . '</p>' |
|
| 841 | + . $close |
|
| 842 | + . '</div>'; |
|
| 843 | + } |
|
| 844 | + if ($error_messages !== '') { |
|
| 845 | + $css_id = is_admin() ? 'message' : 'espresso-notices-error'; |
|
| 846 | + $css_class = is_admin() ? 'error' : 'error fade-away'; |
|
| 847 | + //showMessage( $error_messages, TRUE ); |
|
| 848 | + $notices .= '<div id="' |
|
| 849 | + . $css_id |
|
| 850 | + . '" class="espresso-notices ' |
|
| 851 | + . $css_class |
|
| 852 | + . '" style="display:none;"><p>' |
|
| 853 | + . $error_messages |
|
| 854 | + . '</p>' |
|
| 855 | + . $close |
|
| 856 | + . '</div>'; |
|
| 857 | + } |
|
| 858 | + $notices .= '</div>'; |
|
| 859 | + } else { |
|
| 860 | + $notices = array( |
|
| 861 | + 'success' => $success_messages, |
|
| 862 | + 'attention' => $attention_messages, |
|
| 863 | + 'errors' => $error_messages, |
|
| 864 | + ); |
|
| 865 | + if ($remove_empty) { |
|
| 866 | + // remove empty notices |
|
| 867 | + foreach ($notices as $type => $notice) { |
|
| 868 | + if (empty($notice)) { |
|
| 869 | + unset($notices[$type]); |
|
| 870 | + } |
|
| 871 | + } |
|
| 872 | + } |
|
| 873 | + } |
|
| 874 | + if ($print_scripts) { |
|
| 875 | + self::_print_scripts(); |
|
| 876 | + } |
|
| 877 | + return $notices; |
|
| 878 | + } |
|
| 879 | + |
|
| 880 | + |
|
| 881 | + |
|
| 882 | + /** |
|
| 883 | + * add_persistent_admin_notice |
|
| 884 | + * |
|
| 885 | + * @param string $pan_name the name, or key of the Persistent Admin Notice to be stored |
|
| 886 | + * @param string $pan_message the message to be stored persistently until dismissed |
|
| 887 | + * @param bool $force_update allows one to enforce the reappearance of a persistent message. |
|
| 888 | + * @return void |
|
| 889 | + */ |
|
| 890 | + public static function add_persistent_admin_notice($pan_name = '', $pan_message, $force_update = false) |
|
| 891 | + { |
|
| 892 | + if (! empty($pan_name) && ! empty($pan_message)) { |
|
| 893 | + $persistent_admin_notices = get_option('ee_pers_admin_notices', array()); |
|
| 894 | + //maybe initialize persistent_admin_notices |
|
| 895 | + if (empty($persistent_admin_notices)) { |
|
| 896 | + add_option('ee_pers_admin_notices', array(), '', 'no'); |
|
| 897 | + } |
|
| 898 | + $pan_name = sanitize_key($pan_name); |
|
| 899 | + if (! array_key_exists($pan_name, $persistent_admin_notices) || $force_update) { |
|
| 900 | + $persistent_admin_notices[$pan_name] = $pan_message; |
|
| 901 | + update_option('ee_pers_admin_notices', $persistent_admin_notices); |
|
| 902 | + } |
|
| 903 | + } |
|
| 904 | + } |
|
| 905 | + |
|
| 906 | + |
|
| 907 | + |
|
| 908 | + /** |
|
| 909 | + * dismiss_persistent_admin_notice |
|
| 910 | + * |
|
| 911 | + * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed |
|
| 912 | + * @param bool $purge |
|
| 913 | + * @param bool $return_immediately |
|
| 914 | + * @return void |
|
| 915 | + */ |
|
| 916 | + public static function dismiss_persistent_admin_notice($pan_name = '', $purge = false, $return_immediately = false) |
|
| 917 | + { |
|
| 918 | + $pan_name = EE_Registry::instance()->REQ->is_set('ee_nag_notice') |
|
| 919 | + ? EE_Registry::instance()->REQ->get('ee_nag_notice') : $pan_name; |
|
| 920 | + if (! empty($pan_name)) { |
|
| 921 | + $persistent_admin_notices = get_option('ee_pers_admin_notices', array()); |
|
| 922 | + // check if notice we wish to dismiss is actually in the $persistent_admin_notices array |
|
| 923 | + if (is_array($persistent_admin_notices) && isset($persistent_admin_notices[$pan_name])) { |
|
| 924 | + // completely delete nag notice, or just NULL message so that it can NOT be added again ? |
|
| 925 | + if ($purge) { |
|
| 926 | + unset($persistent_admin_notices[$pan_name]); |
|
| 927 | + } else { |
|
| 928 | + $persistent_admin_notices[$pan_name] = null; |
|
| 929 | + } |
|
| 930 | + if (update_option('ee_pers_admin_notices', $persistent_admin_notices) === false) { |
|
| 931 | + EE_Error::add_error(sprintf(__('The persistent admin notice for "%s" could not be deleted.', |
|
| 932 | + 'event_espresso'), $pan_name), __FILE__, __FUNCTION__, __LINE__); |
|
| 933 | + } |
|
| 934 | + } |
|
| 935 | + } |
|
| 936 | + if ($return_immediately) { |
|
| 937 | + return; |
|
| 938 | + } |
|
| 939 | + if (EE_Registry::instance()->REQ->ajax) { |
|
| 940 | + // grab any notices and concatenate into string |
|
| 941 | + echo wp_json_encode(array('errors' => implode('<br />', EE_Error::get_notices(false)))); |
|
| 942 | + exit(); |
|
| 943 | + } |
|
| 944 | + // save errors to a transient to be displayed on next request (after redirect) |
|
| 945 | + EE_Error::get_notices(false, true); |
|
| 946 | + $return_url = EE_Registry::instance()->REQ->is_set('return_url') |
|
| 947 | + ? EE_Registry::instance()->REQ->get('return_url') : ''; |
|
| 948 | + wp_safe_redirect(urldecode($return_url)); |
|
| 949 | + } |
|
| 950 | + |
|
| 951 | + |
|
| 952 | + |
|
| 953 | + /** |
|
| 954 | + * display_persistent_admin_notices |
|
| 955 | + * |
|
| 956 | + * @param string $pan_name the name, or key of the Persistent Admin Notice to be stored |
|
| 957 | + * @param string $pan_message the message to be stored persistently until dismissed |
|
| 958 | + * @param string $return_url URL to go back to after nag notice is dismissed |
|
| 959 | + * @return string |
|
| 960 | + */ |
|
| 961 | + public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '') |
|
| 962 | + { |
|
| 963 | + if (! empty($pan_name) && ! empty($pan_message)) { |
|
| 964 | + $args = array( |
|
| 965 | + 'nag_notice' => $pan_name, |
|
| 966 | + 'return_url' => urlencode($return_url), |
|
| 967 | + 'ajax_url' => WP_AJAX_URL, |
|
| 968 | + 'unknown_error' => esc_html__( |
|
| 969 | + 'An unknown error has occurred on the server while attempting to dismiss this notice.', |
|
| 970 | + 'event_espresso' |
|
| 971 | + ), |
|
| 972 | + ); |
|
| 973 | + EE_Registry::$i18n_js_strings = array_merge( |
|
| 974 | + EE_Registry::$i18n_js_strings, |
|
| 975 | + array('ee_dismiss' => $args) |
|
| 976 | + ); |
|
| 977 | + return ' |
|
| 978 | 978 | <div id="' |
| 979 | - . $pan_name |
|
| 980 | - . '" class="espresso-notices updated ee-nag-notice clearfix" style="border-left: 4px solid #fcb93c;"> |
|
| 979 | + . $pan_name |
|
| 980 | + . '" class="espresso-notices updated ee-nag-notice clearfix" style="border-left: 4px solid #fcb93c;"> |
|
| 981 | 981 | <p>' |
| 982 | - . $pan_message |
|
| 983 | - . '</p> |
|
| 982 | + . $pan_message |
|
| 983 | + . '</p> |
|
| 984 | 984 | <a class="dismiss-ee-nag-notice hide-if-no-js" style="float: right; cursor: pointer; text-decoration:none;" rel="' |
| 985 | - . $pan_name |
|
| 986 | - . '"> |
|
| 985 | + . $pan_name |
|
| 986 | + . '"> |
|
| 987 | 987 | <span class="dashicons dashicons-dismiss" style="position:relative; top:-1px; margin-right:.25em;"></span>' |
| 988 | - . __('Dismiss', 'event_espresso') |
|
| 989 | - . ' |
|
| 988 | + . __('Dismiss', 'event_espresso') |
|
| 989 | + . ' |
|
| 990 | 990 | </a> |
| 991 | 991 | <div style="clear:both;"></div> |
| 992 | 992 | </div>'; |
| 993 | - } |
|
| 994 | - return ''; |
|
| 995 | - } |
|
| 996 | - |
|
| 997 | - |
|
| 998 | - |
|
| 999 | - /** |
|
| 1000 | - * get_persistent_admin_notices |
|
| 1001 | - * |
|
| 1002 | - * @param string $return_url |
|
| 1003 | - * @return string |
|
| 1004 | - */ |
|
| 1005 | - public static function get_persistent_admin_notices($return_url = '') |
|
| 1006 | - { |
|
| 1007 | - $notices = ''; |
|
| 1008 | - // check for persistent admin notices |
|
| 1009 | - //filter the list though so plugins can notify the admin in a different way if they want |
|
| 1010 | - $persistent_admin_notices = apply_filters( |
|
| 1011 | - 'FHEE__EE_Error__get_persistent_admin_notices', |
|
| 1012 | - get_option('ee_pers_admin_notices', false), |
|
| 1013 | - 'ee_pers_admin_notices', |
|
| 1014 | - $return_url |
|
| 1015 | - ); |
|
| 1016 | - if ($persistent_admin_notices) { |
|
| 1017 | - // load scripts |
|
| 1018 | - wp_register_script( |
|
| 1019 | - 'espresso_core', |
|
| 1020 | - EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', |
|
| 1021 | - array('jquery'), |
|
| 1022 | - EVENT_ESPRESSO_VERSION, |
|
| 1023 | - true |
|
| 1024 | - ); |
|
| 1025 | - wp_register_script( |
|
| 1026 | - 'ee_error_js', |
|
| 1027 | - EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js', |
|
| 1028 | - array('espresso_core'), |
|
| 1029 | - EVENT_ESPRESSO_VERSION, |
|
| 1030 | - true |
|
| 1031 | - ); |
|
| 1032 | - wp_enqueue_script('ee_error_js'); |
|
| 1033 | - // and display notices |
|
| 1034 | - foreach ($persistent_admin_notices as $pan_name => $pan_message) { |
|
| 1035 | - $notices .= self::display_persistent_admin_notices($pan_name, $pan_message, $return_url); |
|
| 1036 | - } |
|
| 1037 | - } |
|
| 1038 | - return $notices; |
|
| 1039 | - } |
|
| 1040 | - |
|
| 1041 | - |
|
| 1042 | - |
|
| 1043 | - /** |
|
| 1044 | - * _print_scripts |
|
| 1045 | - * |
|
| 1046 | - * @param bool $force_print |
|
| 1047 | - * @return string |
|
| 1048 | - */ |
|
| 1049 | - private static function _print_scripts($force_print = false) |
|
| 1050 | - { |
|
| 1051 | - if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) { |
|
| 1052 | - if (wp_script_is('ee_error_js', 'enqueued')) { |
|
| 1053 | - return ''; |
|
| 1054 | - } |
|
| 1055 | - if (wp_script_is('ee_error_js', 'registered')) { |
|
| 1056 | - wp_enqueue_style('espresso_default'); |
|
| 1057 | - wp_enqueue_style('espresso_custom_css'); |
|
| 1058 | - wp_enqueue_script('ee_error_js'); |
|
| 1059 | - wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG)); |
|
| 1060 | - } |
|
| 1061 | - } else { |
|
| 1062 | - return ' |
|
| 993 | + } |
|
| 994 | + return ''; |
|
| 995 | + } |
|
| 996 | + |
|
| 997 | + |
|
| 998 | + |
|
| 999 | + /** |
|
| 1000 | + * get_persistent_admin_notices |
|
| 1001 | + * |
|
| 1002 | + * @param string $return_url |
|
| 1003 | + * @return string |
|
| 1004 | + */ |
|
| 1005 | + public static function get_persistent_admin_notices($return_url = '') |
|
| 1006 | + { |
|
| 1007 | + $notices = ''; |
|
| 1008 | + // check for persistent admin notices |
|
| 1009 | + //filter the list though so plugins can notify the admin in a different way if they want |
|
| 1010 | + $persistent_admin_notices = apply_filters( |
|
| 1011 | + 'FHEE__EE_Error__get_persistent_admin_notices', |
|
| 1012 | + get_option('ee_pers_admin_notices', false), |
|
| 1013 | + 'ee_pers_admin_notices', |
|
| 1014 | + $return_url |
|
| 1015 | + ); |
|
| 1016 | + if ($persistent_admin_notices) { |
|
| 1017 | + // load scripts |
|
| 1018 | + wp_register_script( |
|
| 1019 | + 'espresso_core', |
|
| 1020 | + EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', |
|
| 1021 | + array('jquery'), |
|
| 1022 | + EVENT_ESPRESSO_VERSION, |
|
| 1023 | + true |
|
| 1024 | + ); |
|
| 1025 | + wp_register_script( |
|
| 1026 | + 'ee_error_js', |
|
| 1027 | + EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js', |
|
| 1028 | + array('espresso_core'), |
|
| 1029 | + EVENT_ESPRESSO_VERSION, |
|
| 1030 | + true |
|
| 1031 | + ); |
|
| 1032 | + wp_enqueue_script('ee_error_js'); |
|
| 1033 | + // and display notices |
|
| 1034 | + foreach ($persistent_admin_notices as $pan_name => $pan_message) { |
|
| 1035 | + $notices .= self::display_persistent_admin_notices($pan_name, $pan_message, $return_url); |
|
| 1036 | + } |
|
| 1037 | + } |
|
| 1038 | + return $notices; |
|
| 1039 | + } |
|
| 1040 | + |
|
| 1041 | + |
|
| 1042 | + |
|
| 1043 | + /** |
|
| 1044 | + * _print_scripts |
|
| 1045 | + * |
|
| 1046 | + * @param bool $force_print |
|
| 1047 | + * @return string |
|
| 1048 | + */ |
|
| 1049 | + private static function _print_scripts($force_print = false) |
|
| 1050 | + { |
|
| 1051 | + if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) { |
|
| 1052 | + if (wp_script_is('ee_error_js', 'enqueued')) { |
|
| 1053 | + return ''; |
|
| 1054 | + } |
|
| 1055 | + if (wp_script_is('ee_error_js', 'registered')) { |
|
| 1056 | + wp_enqueue_style('espresso_default'); |
|
| 1057 | + wp_enqueue_style('espresso_custom_css'); |
|
| 1058 | + wp_enqueue_script('ee_error_js'); |
|
| 1059 | + wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG)); |
|
| 1060 | + } |
|
| 1061 | + } else { |
|
| 1062 | + return ' |
|
| 1063 | 1063 | <script> |
| 1064 | 1064 | /* <![CDATA[ */ |
| 1065 | 1065 | var ee_settings = {"wp_debug":"' . WP_DEBUG . '"}; |
@@ -1069,143 +1069,143 @@ discard block |
||
| 1069 | 1069 | <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script> |
| 1070 | 1070 | <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script> |
| 1071 | 1071 | '; |
| 1072 | - } |
|
| 1073 | - return ''; |
|
| 1074 | - } |
|
| 1075 | - |
|
| 1076 | - |
|
| 1077 | - |
|
| 1078 | - /** |
|
| 1079 | - * enqueue_error_scripts |
|
| 1080 | - * |
|
| 1081 | - * @return void |
|
| 1082 | - */ |
|
| 1083 | - public static function enqueue_error_scripts() |
|
| 1084 | - { |
|
| 1085 | - self::_print_scripts(); |
|
| 1086 | - } |
|
| 1087 | - |
|
| 1088 | - |
|
| 1089 | - |
|
| 1090 | - /** |
|
| 1091 | - * create error code from filepath, function name, |
|
| 1092 | - * and line number where exception or error was thrown |
|
| 1093 | - * |
|
| 1094 | - * @param string $file |
|
| 1095 | - * @param string $func |
|
| 1096 | - * @param string $line |
|
| 1097 | - * @return string |
|
| 1098 | - */ |
|
| 1099 | - public static function generate_error_code($file = '', $func = '', $line = '') |
|
| 1100 | - { |
|
| 1101 | - $file = explode('.', basename($file)); |
|
| 1102 | - $error_code = ! empty($file[0]) ? $file[0] : ''; |
|
| 1103 | - $error_code .= ! empty($func) ? ' - ' . $func : ''; |
|
| 1104 | - $error_code .= ! empty($line) ? ' - ' . $line : ''; |
|
| 1105 | - return $error_code; |
|
| 1106 | - } |
|
| 1107 | - |
|
| 1108 | - |
|
| 1109 | - |
|
| 1110 | - /** |
|
| 1111 | - * write exception details to log file |
|
| 1112 | - * |
|
| 1113 | - * @param int $time |
|
| 1114 | - * @param array $ex |
|
| 1115 | - * @param bool $clear |
|
| 1116 | - * @return void |
|
| 1117 | - */ |
|
| 1118 | - public function write_to_error_log($time = 0, $ex = array(), $clear = false) |
|
| 1119 | - { |
|
| 1120 | - if (empty($ex)) { |
|
| 1121 | - return; |
|
| 1122 | - } |
|
| 1123 | - if (! $time) { |
|
| 1124 | - $time = time(); |
|
| 1125 | - } |
|
| 1126 | - $exception_log = '----------------------------------------------------------------------------------------' |
|
| 1127 | - . PHP_EOL; |
|
| 1128 | - $exception_log .= '[' . date('Y-m-d H:i:s', $time) . '] Exception Details' . PHP_EOL; |
|
| 1129 | - $exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL; |
|
| 1130 | - $exception_log .= 'Code: ' . $ex['code'] . PHP_EOL; |
|
| 1131 | - $exception_log .= 'File: ' . $ex['file'] . PHP_EOL; |
|
| 1132 | - $exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL; |
|
| 1133 | - $exception_log .= 'Stack trace: ' . PHP_EOL; |
|
| 1134 | - $exception_log .= $ex['string'] . PHP_EOL; |
|
| 1135 | - $exception_log .= '----------------------------------------------------------------------------------------' |
|
| 1136 | - . PHP_EOL; |
|
| 1137 | - try { |
|
| 1138 | - EEH_File::ensure_file_exists_and_is_writable( |
|
| 1139 | - EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file |
|
| 1140 | - ); |
|
| 1141 | - EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR . 'logs'); |
|
| 1142 | - if (! $clear) { |
|
| 1143 | - //get existing log file and append new log info |
|
| 1144 | - $exception_log = EEH_File::get_file_contents( |
|
| 1145 | - EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file |
|
| 1146 | - ) . $exception_log; |
|
| 1147 | - } |
|
| 1148 | - EEH_File::write_to_file( |
|
| 1149 | - EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file, |
|
| 1150 | - $exception_log |
|
| 1151 | - ); |
|
| 1152 | - } catch (EE_Error $e) { |
|
| 1153 | - EE_Error::add_error(sprintf(__('Event Espresso error logging could not be setup because: %s', |
|
| 1154 | - 'event_espresso'), $e->getMessage())); |
|
| 1155 | - return; |
|
| 1156 | - } |
|
| 1157 | - } |
|
| 1158 | - |
|
| 1159 | - |
|
| 1160 | - |
|
| 1161 | - /** |
|
| 1162 | - * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method. |
|
| 1163 | - * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown, |
|
| 1164 | - * but the code execution is done in a manner that could lead to unexpected results |
|
| 1165 | - * (i.e. running to early, or too late in WP or EE loading process). |
|
| 1166 | - * A good test for knowing whether to use this method is: |
|
| 1167 | - * 1. Is there going to be a PHP error if something isn't setup/used correctly? |
|
| 1168 | - * Yes -> use EE_Error::add_error() or throw new EE_Error() |
|
| 1169 | - * 2. If this is loaded before something else, it won't break anything, |
|
| 1170 | - * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong() |
|
| 1171 | - * |
|
| 1172 | - * @uses constant WP_DEBUG test if wp_debug is on or not |
|
| 1173 | - * @param string $function The function that was called |
|
| 1174 | - * @param string $message A message explaining what has been done incorrectly |
|
| 1175 | - * @param string $version The version of Event Espresso where the error was added |
|
| 1176 | - * @param string $applies_when a version string for when you want the doing_it_wrong notice to begin appearing |
|
| 1177 | - * for a deprecated function. This allows deprecation to occur during one version, |
|
| 1178 | - * but not have any notices appear until a later version. This allows developers |
|
| 1179 | - * extra time to update their code before notices appear. |
|
| 1180 | - * @param int $error_type |
|
| 1181 | - */ |
|
| 1182 | - public static function doing_it_wrong( |
|
| 1183 | - $function, |
|
| 1184 | - $message, |
|
| 1185 | - $version, |
|
| 1186 | - $applies_when = '', |
|
| 1187 | - $error_type = null |
|
| 1188 | - ) { |
|
| 1189 | - if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 1190 | - EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type); |
|
| 1191 | - } |
|
| 1192 | - } |
|
| 1193 | - |
|
| 1194 | - |
|
| 1195 | - |
|
| 1196 | - /** |
|
| 1197 | - * Like get_notices, but returns an array of all the notices of the given type. |
|
| 1198 | - * |
|
| 1199 | - * @return array { |
|
| 1200 | - * @type array $success all the success messages |
|
| 1201 | - * @type array $errors all the error messages |
|
| 1202 | - * @type array $attention all the attention messages |
|
| 1203 | - * } |
|
| 1204 | - */ |
|
| 1205 | - public static function get_raw_notices() |
|
| 1206 | - { |
|
| 1207 | - return self::$_espresso_notices; |
|
| 1208 | - } |
|
| 1072 | + } |
|
| 1073 | + return ''; |
|
| 1074 | + } |
|
| 1075 | + |
|
| 1076 | + |
|
| 1077 | + |
|
| 1078 | + /** |
|
| 1079 | + * enqueue_error_scripts |
|
| 1080 | + * |
|
| 1081 | + * @return void |
|
| 1082 | + */ |
|
| 1083 | + public static function enqueue_error_scripts() |
|
| 1084 | + { |
|
| 1085 | + self::_print_scripts(); |
|
| 1086 | + } |
|
| 1087 | + |
|
| 1088 | + |
|
| 1089 | + |
|
| 1090 | + /** |
|
| 1091 | + * create error code from filepath, function name, |
|
| 1092 | + * and line number where exception or error was thrown |
|
| 1093 | + * |
|
| 1094 | + * @param string $file |
|
| 1095 | + * @param string $func |
|
| 1096 | + * @param string $line |
|
| 1097 | + * @return string |
|
| 1098 | + */ |
|
| 1099 | + public static function generate_error_code($file = '', $func = '', $line = '') |
|
| 1100 | + { |
|
| 1101 | + $file = explode('.', basename($file)); |
|
| 1102 | + $error_code = ! empty($file[0]) ? $file[0] : ''; |
|
| 1103 | + $error_code .= ! empty($func) ? ' - ' . $func : ''; |
|
| 1104 | + $error_code .= ! empty($line) ? ' - ' . $line : ''; |
|
| 1105 | + return $error_code; |
|
| 1106 | + } |
|
| 1107 | + |
|
| 1108 | + |
|
| 1109 | + |
|
| 1110 | + /** |
|
| 1111 | + * write exception details to log file |
|
| 1112 | + * |
|
| 1113 | + * @param int $time |
|
| 1114 | + * @param array $ex |
|
| 1115 | + * @param bool $clear |
|
| 1116 | + * @return void |
|
| 1117 | + */ |
|
| 1118 | + public function write_to_error_log($time = 0, $ex = array(), $clear = false) |
|
| 1119 | + { |
|
| 1120 | + if (empty($ex)) { |
|
| 1121 | + return; |
|
| 1122 | + } |
|
| 1123 | + if (! $time) { |
|
| 1124 | + $time = time(); |
|
| 1125 | + } |
|
| 1126 | + $exception_log = '----------------------------------------------------------------------------------------' |
|
| 1127 | + . PHP_EOL; |
|
| 1128 | + $exception_log .= '[' . date('Y-m-d H:i:s', $time) . '] Exception Details' . PHP_EOL; |
|
| 1129 | + $exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL; |
|
| 1130 | + $exception_log .= 'Code: ' . $ex['code'] . PHP_EOL; |
|
| 1131 | + $exception_log .= 'File: ' . $ex['file'] . PHP_EOL; |
|
| 1132 | + $exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL; |
|
| 1133 | + $exception_log .= 'Stack trace: ' . PHP_EOL; |
|
| 1134 | + $exception_log .= $ex['string'] . PHP_EOL; |
|
| 1135 | + $exception_log .= '----------------------------------------------------------------------------------------' |
|
| 1136 | + . PHP_EOL; |
|
| 1137 | + try { |
|
| 1138 | + EEH_File::ensure_file_exists_and_is_writable( |
|
| 1139 | + EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file |
|
| 1140 | + ); |
|
| 1141 | + EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR . 'logs'); |
|
| 1142 | + if (! $clear) { |
|
| 1143 | + //get existing log file and append new log info |
|
| 1144 | + $exception_log = EEH_File::get_file_contents( |
|
| 1145 | + EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file |
|
| 1146 | + ) . $exception_log; |
|
| 1147 | + } |
|
| 1148 | + EEH_File::write_to_file( |
|
| 1149 | + EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file, |
|
| 1150 | + $exception_log |
|
| 1151 | + ); |
|
| 1152 | + } catch (EE_Error $e) { |
|
| 1153 | + EE_Error::add_error(sprintf(__('Event Espresso error logging could not be setup because: %s', |
|
| 1154 | + 'event_espresso'), $e->getMessage())); |
|
| 1155 | + return; |
|
| 1156 | + } |
|
| 1157 | + } |
|
| 1158 | + |
|
| 1159 | + |
|
| 1160 | + |
|
| 1161 | + /** |
|
| 1162 | + * This is just a wrapper for the EEH_Debug_Tools::instance()->doing_it_wrong() method. |
|
| 1163 | + * doing_it_wrong() is used in those cases where a normal PHP error won't get thrown, |
|
| 1164 | + * but the code execution is done in a manner that could lead to unexpected results |
|
| 1165 | + * (i.e. running to early, or too late in WP or EE loading process). |
|
| 1166 | + * A good test for knowing whether to use this method is: |
|
| 1167 | + * 1. Is there going to be a PHP error if something isn't setup/used correctly? |
|
| 1168 | + * Yes -> use EE_Error::add_error() or throw new EE_Error() |
|
| 1169 | + * 2. If this is loaded before something else, it won't break anything, |
|
| 1170 | + * but just wont' do what its supposed to do? Yes -> use EE_Error::doing_it_wrong() |
|
| 1171 | + * |
|
| 1172 | + * @uses constant WP_DEBUG test if wp_debug is on or not |
|
| 1173 | + * @param string $function The function that was called |
|
| 1174 | + * @param string $message A message explaining what has been done incorrectly |
|
| 1175 | + * @param string $version The version of Event Espresso where the error was added |
|
| 1176 | + * @param string $applies_when a version string for when you want the doing_it_wrong notice to begin appearing |
|
| 1177 | + * for a deprecated function. This allows deprecation to occur during one version, |
|
| 1178 | + * but not have any notices appear until a later version. This allows developers |
|
| 1179 | + * extra time to update their code before notices appear. |
|
| 1180 | + * @param int $error_type |
|
| 1181 | + */ |
|
| 1182 | + public static function doing_it_wrong( |
|
| 1183 | + $function, |
|
| 1184 | + $message, |
|
| 1185 | + $version, |
|
| 1186 | + $applies_when = '', |
|
| 1187 | + $error_type = null |
|
| 1188 | + ) { |
|
| 1189 | + if (defined('WP_DEBUG') && WP_DEBUG) { |
|
| 1190 | + EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type); |
|
| 1191 | + } |
|
| 1192 | + } |
|
| 1193 | + |
|
| 1194 | + |
|
| 1195 | + |
|
| 1196 | + /** |
|
| 1197 | + * Like get_notices, but returns an array of all the notices of the given type. |
|
| 1198 | + * |
|
| 1199 | + * @return array { |
|
| 1200 | + * @type array $success all the success messages |
|
| 1201 | + * @type array $errors all the error messages |
|
| 1202 | + * @type array $attention all the attention messages |
|
| 1203 | + * } |
|
| 1204 | + */ |
|
| 1205 | + public static function get_raw_notices() |
|
| 1206 | + { |
|
| 1207 | + return self::$_espresso_notices; |
|
| 1208 | + } |
|
| 1209 | 1209 | |
| 1210 | 1210 | |
| 1211 | 1211 | |
@@ -1221,27 +1221,27 @@ discard block |
||
| 1221 | 1221 | */ |
| 1222 | 1222 | function espresso_error_enqueue_scripts() |
| 1223 | 1223 | { |
| 1224 | - // js for error handling |
|
| 1225 | - wp_register_script( |
|
| 1226 | - 'espresso_core', |
|
| 1227 | - EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', |
|
| 1228 | - array('jquery'), |
|
| 1229 | - EVENT_ESPRESSO_VERSION, |
|
| 1230 | - false |
|
| 1231 | - ); |
|
| 1232 | - wp_register_script( |
|
| 1233 | - 'ee_error_js', |
|
| 1234 | - EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js', |
|
| 1235 | - array('espresso_core'), |
|
| 1236 | - EVENT_ESPRESSO_VERSION, |
|
| 1237 | - false |
|
| 1238 | - ); |
|
| 1224 | + // js for error handling |
|
| 1225 | + wp_register_script( |
|
| 1226 | + 'espresso_core', |
|
| 1227 | + EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', |
|
| 1228 | + array('jquery'), |
|
| 1229 | + EVENT_ESPRESSO_VERSION, |
|
| 1230 | + false |
|
| 1231 | + ); |
|
| 1232 | + wp_register_script( |
|
| 1233 | + 'ee_error_js', |
|
| 1234 | + EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js', |
|
| 1235 | + array('espresso_core'), |
|
| 1236 | + EVENT_ESPRESSO_VERSION, |
|
| 1237 | + false |
|
| 1238 | + ); |
|
| 1239 | 1239 | } |
| 1240 | 1240 | |
| 1241 | 1241 | if (is_admin()) { |
| 1242 | - add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 2); |
|
| 1242 | + add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 2); |
|
| 1243 | 1243 | } else { |
| 1244 | - add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 2); |
|
| 1244 | + add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 2); |
|
| 1245 | 1245 | } |
| 1246 | 1246 | |
| 1247 | 1247 | |
@@ -1,5 +1,5 @@ discard block |
||
| 1 | 1 | <?php if ( ! defined('ABSPATH')) { |
| 2 | - exit('No direct script access allowed'); |
|
| 2 | + exit('No direct script access allowed'); |
|
| 3 | 3 | } |
| 4 | 4 | /* |
| 5 | 5 | Plugin Name: Event Espresso |
@@ -40,243 +40,243 @@ discard block |
||
| 40 | 40 | * @since 4.0 |
| 41 | 41 | */ |
| 42 | 42 | if (function_exists('espresso_version')) { |
| 43 | - /** |
|
| 44 | - * espresso_duplicate_plugin_error |
|
| 45 | - * displays if more than one version of EE is activated at the same time |
|
| 46 | - */ |
|
| 47 | - function espresso_duplicate_plugin_error() |
|
| 48 | - { |
|
| 49 | - ?> |
|
| 43 | + /** |
|
| 44 | + * espresso_duplicate_plugin_error |
|
| 45 | + * displays if more than one version of EE is activated at the same time |
|
| 46 | + */ |
|
| 47 | + function espresso_duplicate_plugin_error() |
|
| 48 | + { |
|
| 49 | + ?> |
|
| 50 | 50 | <div class="error"> |
| 51 | 51 | <p> |
| 52 | 52 | <?php echo esc_html__( |
| 53 | - 'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.', |
|
| 54 | - 'event_espresso' |
|
| 55 | - ); ?> |
|
| 53 | + 'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.', |
|
| 54 | + 'event_espresso' |
|
| 55 | + ); ?> |
|
| 56 | 56 | </p> |
| 57 | 57 | </div> |
| 58 | 58 | <?php |
| 59 | - espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
| 60 | - } |
|
| 59 | + espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
| 60 | + } |
|
| 61 | 61 | |
| 62 | - add_action('admin_notices', 'espresso_duplicate_plugin_error', 1); |
|
| 62 | + add_action('admin_notices', 'espresso_duplicate_plugin_error', 1); |
|
| 63 | 63 | } else { |
| 64 | - define('EE_MIN_PHP_VER_REQUIRED', '5.3.9'); |
|
| 65 | - if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) { |
|
| 66 | - /** |
|
| 67 | - * espresso_minimum_php_version_error |
|
| 68 | - * |
|
| 69 | - * @return void |
|
| 70 | - */ |
|
| 71 | - function espresso_minimum_php_version_error() |
|
| 72 | - { |
|
| 73 | - ?> |
|
| 64 | + define('EE_MIN_PHP_VER_REQUIRED', '5.3.9'); |
|
| 65 | + if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) { |
|
| 66 | + /** |
|
| 67 | + * espresso_minimum_php_version_error |
|
| 68 | + * |
|
| 69 | + * @return void |
|
| 70 | + */ |
|
| 71 | + function espresso_minimum_php_version_error() |
|
| 72 | + { |
|
| 73 | + ?> |
|
| 74 | 74 | <div class="error"> |
| 75 | 75 | <p> |
| 76 | 76 | <?php |
| 77 | - printf( |
|
| 78 | - esc_html__( |
|
| 79 | - 'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.', |
|
| 80 | - 'event_espresso' |
|
| 81 | - ), |
|
| 82 | - EE_MIN_PHP_VER_REQUIRED, |
|
| 83 | - PHP_VERSION, |
|
| 84 | - '<br/>', |
|
| 85 | - '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>' |
|
| 86 | - ); |
|
| 87 | - ?> |
|
| 77 | + printf( |
|
| 78 | + esc_html__( |
|
| 79 | + 'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.', |
|
| 80 | + 'event_espresso' |
|
| 81 | + ), |
|
| 82 | + EE_MIN_PHP_VER_REQUIRED, |
|
| 83 | + PHP_VERSION, |
|
| 84 | + '<br/>', |
|
| 85 | + '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>' |
|
| 86 | + ); |
|
| 87 | + ?> |
|
| 88 | 88 | </p> |
| 89 | 89 | </div> |
| 90 | 90 | <?php |
| 91 | - espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
| 92 | - } |
|
| 91 | + espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
| 92 | + } |
|
| 93 | 93 | |
| 94 | - add_action('admin_notices', 'espresso_minimum_php_version_error', 1); |
|
| 95 | - } else { |
|
| 96 | - /** |
|
| 97 | - * espresso_version |
|
| 98 | - * Returns the plugin version |
|
| 99 | - * |
|
| 100 | - * @return string |
|
| 101 | - */ |
|
| 102 | - function espresso_version() |
|
| 103 | - { |
|
| 104 | - return apply_filters('FHEE__espresso__espresso_version', '4.9.44.rc.030'); |
|
| 105 | - } |
|
| 94 | + add_action('admin_notices', 'espresso_minimum_php_version_error', 1); |
|
| 95 | + } else { |
|
| 96 | + /** |
|
| 97 | + * espresso_version |
|
| 98 | + * Returns the plugin version |
|
| 99 | + * |
|
| 100 | + * @return string |
|
| 101 | + */ |
|
| 102 | + function espresso_version() |
|
| 103 | + { |
|
| 104 | + return apply_filters('FHEE__espresso__espresso_version', '4.9.44.rc.030'); |
|
| 105 | + } |
|
| 106 | 106 | |
| 107 | - // define versions |
|
| 108 | - define('EVENT_ESPRESSO_VERSION', espresso_version()); |
|
| 109 | - define('EE_MIN_WP_VER_REQUIRED', '4.1'); |
|
| 110 | - define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2'); |
|
| 111 | - define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44'); |
|
| 112 | - define('EVENT_ESPRESSO_MAIN_FILE', __FILE__); |
|
| 113 | - //used to be DIRECTORY_SEPARATOR, but that caused issues on windows |
|
| 114 | - if ( ! defined('DS')) { |
|
| 115 | - define('DS', '/'); |
|
| 116 | - } |
|
| 117 | - if ( ! defined('PS')) { |
|
| 118 | - define('PS', PATH_SEPARATOR); |
|
| 119 | - } |
|
| 120 | - if ( ! defined('SP')) { |
|
| 121 | - define('SP', ' '); |
|
| 122 | - } |
|
| 123 | - if ( ! defined('EENL')) { |
|
| 124 | - define('EENL', "\n"); |
|
| 125 | - } |
|
| 126 | - define('EE_SUPPORT_EMAIL', '[email protected]'); |
|
| 127 | - // define the plugin directory and URL |
|
| 128 | - define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE)); |
|
| 129 | - define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE)); |
|
| 130 | - define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE)); |
|
| 131 | - // main root folder paths |
|
| 132 | - define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS); |
|
| 133 | - define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS); |
|
| 134 | - define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS); |
|
| 135 | - define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS); |
|
| 136 | - define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS); |
|
| 137 | - define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS); |
|
| 138 | - define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS); |
|
| 139 | - define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS); |
|
| 140 | - // core system paths |
|
| 141 | - define('EE_ADMIN', EE_CORE . 'admin' . DS); |
|
| 142 | - define('EE_CPTS', EE_CORE . 'CPTs' . DS); |
|
| 143 | - define('EE_CLASSES', EE_CORE . 'db_classes' . DS); |
|
| 144 | - define('EE_INTERFACES', EE_CORE . 'interfaces' . DS); |
|
| 145 | - define('EE_BUSINESS', EE_CORE . 'business' . DS); |
|
| 146 | - define('EE_MODELS', EE_CORE . 'db_models' . DS); |
|
| 147 | - define('EE_HELPERS', EE_CORE . 'helpers' . DS); |
|
| 148 | - define('EE_LIBRARIES', EE_CORE . 'libraries' . DS); |
|
| 149 | - define('EE_TEMPLATES', EE_CORE . 'templates' . DS); |
|
| 150 | - define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS); |
|
| 151 | - define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS); |
|
| 152 | - define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS); |
|
| 153 | - // gateways |
|
| 154 | - define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS); |
|
| 155 | - define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS); |
|
| 156 | - // asset URL paths |
|
| 157 | - define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS); |
|
| 158 | - define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS); |
|
| 159 | - define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS); |
|
| 160 | - define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS); |
|
| 161 | - define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/'); |
|
| 162 | - define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/'); |
|
| 163 | - // define upload paths |
|
| 164 | - $uploads = wp_upload_dir(); |
|
| 165 | - // define the uploads directory and URL |
|
| 166 | - define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS); |
|
| 167 | - define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS); |
|
| 168 | - // define the templates directory and URL |
|
| 169 | - define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS); |
|
| 170 | - define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS); |
|
| 171 | - // define the gateway directory and URL |
|
| 172 | - define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS); |
|
| 173 | - define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS); |
|
| 174 | - // languages folder/path |
|
| 175 | - define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS); |
|
| 176 | - define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS); |
|
| 177 | - //check for dompdf fonts in uploads |
|
| 178 | - if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) { |
|
| 179 | - define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS); |
|
| 180 | - } |
|
| 181 | - //ajax constants |
|
| 182 | - define( |
|
| 183 | - 'EE_FRONT_AJAX', |
|
| 184 | - isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false |
|
| 185 | - ); |
|
| 186 | - define( |
|
| 187 | - 'EE_ADMIN_AJAX', |
|
| 188 | - isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false |
|
| 189 | - ); |
|
| 190 | - //just a handy constant occasionally needed for finding values representing infinity in the DB |
|
| 191 | - //you're better to use this than its straight value (currently -1) in case you ever |
|
| 192 | - //want to change its default value! or find when -1 means infinity |
|
| 193 | - define('EE_INF_IN_DB', -1); |
|
| 194 | - define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX); |
|
| 195 | - define('EE_DEBUG', false); |
|
| 196 | - // for older WP versions |
|
| 197 | - if ( ! defined('MONTH_IN_SECONDS')) { |
|
| 198 | - define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30); |
|
| 199 | - } |
|
| 200 | - /** |
|
| 201 | - * espresso_plugin_activation |
|
| 202 | - * adds a wp-option to indicate that EE has been activated via the WP admin plugins page |
|
| 203 | - */ |
|
| 204 | - function espresso_plugin_activation() |
|
| 205 | - { |
|
| 206 | - update_option('ee_espresso_activation', true); |
|
| 207 | - } |
|
| 107 | + // define versions |
|
| 108 | + define('EVENT_ESPRESSO_VERSION', espresso_version()); |
|
| 109 | + define('EE_MIN_WP_VER_REQUIRED', '4.1'); |
|
| 110 | + define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2'); |
|
| 111 | + define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44'); |
|
| 112 | + define('EVENT_ESPRESSO_MAIN_FILE', __FILE__); |
|
| 113 | + //used to be DIRECTORY_SEPARATOR, but that caused issues on windows |
|
| 114 | + if ( ! defined('DS')) { |
|
| 115 | + define('DS', '/'); |
|
| 116 | + } |
|
| 117 | + if ( ! defined('PS')) { |
|
| 118 | + define('PS', PATH_SEPARATOR); |
|
| 119 | + } |
|
| 120 | + if ( ! defined('SP')) { |
|
| 121 | + define('SP', ' '); |
|
| 122 | + } |
|
| 123 | + if ( ! defined('EENL')) { |
|
| 124 | + define('EENL', "\n"); |
|
| 125 | + } |
|
| 126 | + define('EE_SUPPORT_EMAIL', '[email protected]'); |
|
| 127 | + // define the plugin directory and URL |
|
| 128 | + define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE)); |
|
| 129 | + define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE)); |
|
| 130 | + define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE)); |
|
| 131 | + // main root folder paths |
|
| 132 | + define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS); |
|
| 133 | + define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS); |
|
| 134 | + define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS); |
|
| 135 | + define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS); |
|
| 136 | + define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS); |
|
| 137 | + define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS); |
|
| 138 | + define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS); |
|
| 139 | + define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS); |
|
| 140 | + // core system paths |
|
| 141 | + define('EE_ADMIN', EE_CORE . 'admin' . DS); |
|
| 142 | + define('EE_CPTS', EE_CORE . 'CPTs' . DS); |
|
| 143 | + define('EE_CLASSES', EE_CORE . 'db_classes' . DS); |
|
| 144 | + define('EE_INTERFACES', EE_CORE . 'interfaces' . DS); |
|
| 145 | + define('EE_BUSINESS', EE_CORE . 'business' . DS); |
|
| 146 | + define('EE_MODELS', EE_CORE . 'db_models' . DS); |
|
| 147 | + define('EE_HELPERS', EE_CORE . 'helpers' . DS); |
|
| 148 | + define('EE_LIBRARIES', EE_CORE . 'libraries' . DS); |
|
| 149 | + define('EE_TEMPLATES', EE_CORE . 'templates' . DS); |
|
| 150 | + define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS); |
|
| 151 | + define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS); |
|
| 152 | + define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS); |
|
| 153 | + // gateways |
|
| 154 | + define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS); |
|
| 155 | + define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS); |
|
| 156 | + // asset URL paths |
|
| 157 | + define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS); |
|
| 158 | + define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS); |
|
| 159 | + define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS); |
|
| 160 | + define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS); |
|
| 161 | + define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/'); |
|
| 162 | + define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/'); |
|
| 163 | + // define upload paths |
|
| 164 | + $uploads = wp_upload_dir(); |
|
| 165 | + // define the uploads directory and URL |
|
| 166 | + define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS); |
|
| 167 | + define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS); |
|
| 168 | + // define the templates directory and URL |
|
| 169 | + define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS); |
|
| 170 | + define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS); |
|
| 171 | + // define the gateway directory and URL |
|
| 172 | + define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS); |
|
| 173 | + define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS); |
|
| 174 | + // languages folder/path |
|
| 175 | + define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS); |
|
| 176 | + define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS); |
|
| 177 | + //check for dompdf fonts in uploads |
|
| 178 | + if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) { |
|
| 179 | + define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS); |
|
| 180 | + } |
|
| 181 | + //ajax constants |
|
| 182 | + define( |
|
| 183 | + 'EE_FRONT_AJAX', |
|
| 184 | + isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false |
|
| 185 | + ); |
|
| 186 | + define( |
|
| 187 | + 'EE_ADMIN_AJAX', |
|
| 188 | + isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false |
|
| 189 | + ); |
|
| 190 | + //just a handy constant occasionally needed for finding values representing infinity in the DB |
|
| 191 | + //you're better to use this than its straight value (currently -1) in case you ever |
|
| 192 | + //want to change its default value! or find when -1 means infinity |
|
| 193 | + define('EE_INF_IN_DB', -1); |
|
| 194 | + define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX); |
|
| 195 | + define('EE_DEBUG', false); |
|
| 196 | + // for older WP versions |
|
| 197 | + if ( ! defined('MONTH_IN_SECONDS')) { |
|
| 198 | + define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30); |
|
| 199 | + } |
|
| 200 | + /** |
|
| 201 | + * espresso_plugin_activation |
|
| 202 | + * adds a wp-option to indicate that EE has been activated via the WP admin plugins page |
|
| 203 | + */ |
|
| 204 | + function espresso_plugin_activation() |
|
| 205 | + { |
|
| 206 | + update_option('ee_espresso_activation', true); |
|
| 207 | + } |
|
| 208 | 208 | |
| 209 | - register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation'); |
|
| 210 | - /** |
|
| 211 | - * espresso_load_error_handling |
|
| 212 | - * this function loads EE's class for handling exceptions and errors |
|
| 213 | - */ |
|
| 214 | - function espresso_load_error_handling() |
|
| 215 | - { |
|
| 216 | - // load debugging tools |
|
| 217 | - if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) { |
|
| 218 | - require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php'); |
|
| 219 | - EEH_Debug_Tools::instance(); |
|
| 220 | - } |
|
| 221 | - // load error handling |
|
| 222 | - if (is_readable(EE_CORE . 'EE_Error.core.php')) { |
|
| 223 | - require_once(EE_CORE . 'EE_Error.core.php'); |
|
| 224 | - } else { |
|
| 225 | - wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso')); |
|
| 226 | - } |
|
| 227 | - } |
|
| 209 | + register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation'); |
|
| 210 | + /** |
|
| 211 | + * espresso_load_error_handling |
|
| 212 | + * this function loads EE's class for handling exceptions and errors |
|
| 213 | + */ |
|
| 214 | + function espresso_load_error_handling() |
|
| 215 | + { |
|
| 216 | + // load debugging tools |
|
| 217 | + if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) { |
|
| 218 | + require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php'); |
|
| 219 | + EEH_Debug_Tools::instance(); |
|
| 220 | + } |
|
| 221 | + // load error handling |
|
| 222 | + if (is_readable(EE_CORE . 'EE_Error.core.php')) { |
|
| 223 | + require_once(EE_CORE . 'EE_Error.core.php'); |
|
| 224 | + } else { |
|
| 225 | + wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso')); |
|
| 226 | + } |
|
| 227 | + } |
|
| 228 | 228 | |
| 229 | - /** |
|
| 230 | - * espresso_load_required |
|
| 231 | - * given a class name and path, this function will load that file or throw an exception |
|
| 232 | - * |
|
| 233 | - * @param string $classname |
|
| 234 | - * @param string $full_path_to_file |
|
| 235 | - * @throws EE_Error |
|
| 236 | - */ |
|
| 237 | - function espresso_load_required($classname, $full_path_to_file) |
|
| 238 | - { |
|
| 239 | - static $error_handling_loaded = false; |
|
| 240 | - if ( ! $error_handling_loaded) { |
|
| 241 | - espresso_load_error_handling(); |
|
| 242 | - $error_handling_loaded = true; |
|
| 243 | - } |
|
| 244 | - if (is_readable($full_path_to_file)) { |
|
| 245 | - require_once($full_path_to_file); |
|
| 246 | - } else { |
|
| 247 | - throw new EE_Error ( |
|
| 248 | - sprintf( |
|
| 249 | - esc_html__( |
|
| 250 | - 'The %s class file could not be located or is not readable due to file permissions.', |
|
| 251 | - 'event_espresso' |
|
| 252 | - ), |
|
| 253 | - $classname |
|
| 254 | - ) |
|
| 255 | - ); |
|
| 256 | - } |
|
| 257 | - } |
|
| 229 | + /** |
|
| 230 | + * espresso_load_required |
|
| 231 | + * given a class name and path, this function will load that file or throw an exception |
|
| 232 | + * |
|
| 233 | + * @param string $classname |
|
| 234 | + * @param string $full_path_to_file |
|
| 235 | + * @throws EE_Error |
|
| 236 | + */ |
|
| 237 | + function espresso_load_required($classname, $full_path_to_file) |
|
| 238 | + { |
|
| 239 | + static $error_handling_loaded = false; |
|
| 240 | + if ( ! $error_handling_loaded) { |
|
| 241 | + espresso_load_error_handling(); |
|
| 242 | + $error_handling_loaded = true; |
|
| 243 | + } |
|
| 244 | + if (is_readable($full_path_to_file)) { |
|
| 245 | + require_once($full_path_to_file); |
|
| 246 | + } else { |
|
| 247 | + throw new EE_Error ( |
|
| 248 | + sprintf( |
|
| 249 | + esc_html__( |
|
| 250 | + 'The %s class file could not be located or is not readable due to file permissions.', |
|
| 251 | + 'event_espresso' |
|
| 252 | + ), |
|
| 253 | + $classname |
|
| 254 | + ) |
|
| 255 | + ); |
|
| 256 | + } |
|
| 257 | + } |
|
| 258 | 258 | |
| 259 | - espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php'); |
|
| 260 | - espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php'); |
|
| 261 | - espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php'); |
|
| 262 | - new EE_Bootstrap(); |
|
| 263 | - } |
|
| 259 | + espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php'); |
|
| 260 | + espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php'); |
|
| 261 | + espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php'); |
|
| 262 | + new EE_Bootstrap(); |
|
| 263 | + } |
|
| 264 | 264 | } |
| 265 | 265 | if ( ! function_exists('espresso_deactivate_plugin')) { |
| 266 | - /** |
|
| 267 | - * deactivate_plugin |
|
| 268 | - * usage: espresso_deactivate_plugin( plugin_basename( __FILE__ )); |
|
| 269 | - * |
|
| 270 | - * @access public |
|
| 271 | - * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file |
|
| 272 | - * @return void |
|
| 273 | - */ |
|
| 274 | - function espresso_deactivate_plugin($plugin_basename = '') |
|
| 275 | - { |
|
| 276 | - if ( ! function_exists('deactivate_plugins')) { |
|
| 277 | - require_once(ABSPATH . 'wp-admin/includes/plugin.php'); |
|
| 278 | - } |
|
| 279 | - unset($_GET['activate'], $_REQUEST['activate']); |
|
| 280 | - deactivate_plugins($plugin_basename); |
|
| 281 | - } |
|
| 266 | + /** |
|
| 267 | + * deactivate_plugin |
|
| 268 | + * usage: espresso_deactivate_plugin( plugin_basename( __FILE__ )); |
|
| 269 | + * |
|
| 270 | + * @access public |
|
| 271 | + * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file |
|
| 272 | + * @return void |
|
| 273 | + */ |
|
| 274 | + function espresso_deactivate_plugin($plugin_basename = '') |
|
| 275 | + { |
|
| 276 | + if ( ! function_exists('deactivate_plugins')) { |
|
| 277 | + require_once(ABSPATH . 'wp-admin/includes/plugin.php'); |
|
| 278 | + } |
|
| 279 | + unset($_GET['activate'], $_REQUEST['activate']); |
|
| 280 | + deactivate_plugins($plugin_basename); |
|
| 281 | + } |
|
| 282 | 282 | } |
| 283 | 283 | \ No newline at end of file |
@@ -4,7 +4,7 @@ discard block |
||
| 4 | 4 | use EventEspresso\core\services\loaders\LoaderInterface; |
| 5 | 5 | |
| 6 | 6 | if (! defined('EVENT_ESPRESSO_VERSION')) { |
| 7 | - exit('No direct script access allowed'); |
|
| 7 | + exit('No direct script access allowed'); |
|
| 8 | 8 | } |
| 9 | 9 | |
| 10 | 10 | |
@@ -21,737 +21,737 @@ discard block |
||
| 21 | 21 | class EE_Dependency_Map |
| 22 | 22 | { |
| 23 | 23 | |
| 24 | - /** |
|
| 25 | - * This means that the requested class dependency is not present in the dependency map |
|
| 26 | - */ |
|
| 27 | - const not_registered = 0; |
|
| 28 | - |
|
| 29 | - /** |
|
| 30 | - * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class. |
|
| 31 | - */ |
|
| 32 | - const load_new_object = 1; |
|
| 33 | - |
|
| 34 | - /** |
|
| 35 | - * This instructs class loaders to return a previously instantiated and cached object for the requested class. |
|
| 36 | - * IF a previously instantiated object does not exist, a new one will be created and added to the cache. |
|
| 37 | - */ |
|
| 38 | - const load_from_cache = 2; |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * When registering a dependency, |
|
| 42 | - * this indicates to keep any existing dependencies that already exist, |
|
| 43 | - * and simply discard any new dependencies declared in the incoming data |
|
| 44 | - */ |
|
| 45 | - const KEEP_EXISTING_DEPENDENCIES = 0; |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * When registering a dependency, |
|
| 49 | - * this indicates to overwrite any existing dependencies that already exist using the incoming data |
|
| 50 | - */ |
|
| 51 | - const OVERWRITE_DEPENDENCIES = 1; |
|
| 52 | - |
|
| 53 | - |
|
| 54 | - |
|
| 55 | - /** |
|
| 56 | - * @type EE_Dependency_Map $_instance |
|
| 57 | - */ |
|
| 58 | - protected static $_instance; |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * @type EE_Request $request |
|
| 62 | - */ |
|
| 63 | - protected $_request; |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * @type EE_Response $response |
|
| 67 | - */ |
|
| 68 | - protected $_response; |
|
| 69 | - |
|
| 70 | - /** |
|
| 71 | - * @type LoaderInterface $loader |
|
| 72 | - */ |
|
| 73 | - protected $loader; |
|
| 74 | - |
|
| 75 | - /** |
|
| 76 | - * @type array $_dependency_map |
|
| 77 | - */ |
|
| 78 | - protected $_dependency_map = array(); |
|
| 79 | - |
|
| 80 | - /** |
|
| 81 | - * @type array $_class_loaders |
|
| 82 | - */ |
|
| 83 | - protected $_class_loaders = array(); |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * @type array $_aliases |
|
| 87 | - */ |
|
| 88 | - protected $_aliases = array(); |
|
| 89 | - |
|
| 90 | - |
|
| 91 | - |
|
| 92 | - /** |
|
| 93 | - * EE_Dependency_Map constructor. |
|
| 94 | - * |
|
| 95 | - * @param EE_Request $request |
|
| 96 | - * @param EE_Response $response |
|
| 97 | - */ |
|
| 98 | - protected function __construct(EE_Request $request, EE_Response $response) |
|
| 99 | - { |
|
| 100 | - $this->_request = $request; |
|
| 101 | - $this->_response = $response; |
|
| 102 | - add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize')); |
|
| 103 | - do_action('EE_Dependency_Map____construct'); |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - |
|
| 107 | - |
|
| 108 | - /** |
|
| 109 | - * @throws InvalidDataTypeException |
|
| 110 | - * @throws InvalidInterfaceException |
|
| 111 | - * @throws InvalidArgumentException |
|
| 112 | - */ |
|
| 113 | - public function initialize() |
|
| 114 | - { |
|
| 115 | - $this->_register_core_dependencies(); |
|
| 116 | - $this->_register_core_class_loaders(); |
|
| 117 | - $this->_register_core_aliases(); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - |
|
| 121 | - |
|
| 122 | - /** |
|
| 123 | - * @singleton method used to instantiate class object |
|
| 124 | - * @access public |
|
| 125 | - * @param EE_Request $request |
|
| 126 | - * @param EE_Response $response |
|
| 127 | - * @return EE_Dependency_Map |
|
| 128 | - */ |
|
| 129 | - public static function instance(EE_Request $request = null, EE_Response $response = null) |
|
| 130 | - { |
|
| 131 | - // check if class object is instantiated, and instantiated properly |
|
| 132 | - if (! self::$_instance instanceof EE_Dependency_Map) { |
|
| 133 | - self::$_instance = new EE_Dependency_Map($request, $response); |
|
| 134 | - } |
|
| 135 | - return self::$_instance; |
|
| 136 | - } |
|
| 137 | - |
|
| 138 | - |
|
| 139 | - |
|
| 140 | - /** |
|
| 141 | - * @param LoaderInterface $loader |
|
| 142 | - */ |
|
| 143 | - public function setLoader(LoaderInterface $loader) |
|
| 144 | - { |
|
| 145 | - $this->loader = $loader; |
|
| 146 | - } |
|
| 147 | - |
|
| 148 | - |
|
| 149 | - |
|
| 150 | - /** |
|
| 151 | - * @param string $class |
|
| 152 | - * @param array $dependencies |
|
| 153 | - * @param int $overwrite |
|
| 154 | - * @return bool |
|
| 155 | - */ |
|
| 156 | - public static function register_dependencies( |
|
| 157 | - $class, |
|
| 158 | - array $dependencies, |
|
| 159 | - $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES |
|
| 160 | - ) { |
|
| 161 | - return self::$_instance->registerDependencies($class, $dependencies, $overwrite); |
|
| 162 | - } |
|
| 163 | - |
|
| 164 | - |
|
| 165 | - |
|
| 166 | - /** |
|
| 167 | - * Assigns an array of class names and corresponding load sources (new or cached) |
|
| 168 | - * to the class specified by the first parameter. |
|
| 169 | - * IMPORTANT !!! |
|
| 170 | - * The order of elements in the incoming $dependencies array MUST match |
|
| 171 | - * the order of the constructor parameters for the class in question. |
|
| 172 | - * This is especially important when overriding any existing dependencies that are registered. |
|
| 173 | - * the third parameter controls whether any duplicate dependencies are overwritten or not. |
|
| 174 | - * |
|
| 175 | - * @param string $class |
|
| 176 | - * @param array $dependencies |
|
| 177 | - * @param int $overwrite |
|
| 178 | - * @return bool |
|
| 179 | - */ |
|
| 180 | - public function registerDependencies( |
|
| 181 | - $class, |
|
| 182 | - array $dependencies, |
|
| 183 | - $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES |
|
| 184 | - ) { |
|
| 185 | - $class = trim($class, '\\'); |
|
| 186 | - $registered = false; |
|
| 187 | - if (empty(self::$_instance->_dependency_map[ $class ])) { |
|
| 188 | - self::$_instance->_dependency_map[ $class ] = array(); |
|
| 189 | - } |
|
| 190 | - // we need to make sure that any aliases used when registering a dependency |
|
| 191 | - // get resolved to the correct class name |
|
| 192 | - foreach ((array)$dependencies as $dependency => $load_source) { |
|
| 193 | - $alias = self::$_instance->get_alias($dependency); |
|
| 194 | - if ( |
|
| 195 | - $overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES |
|
| 196 | - || ! isset(self::$_instance->_dependency_map[ $class ][ $alias ]) |
|
| 197 | - ) { |
|
| 198 | - unset($dependencies[$dependency]); |
|
| 199 | - $dependencies[$alias] = $load_source; |
|
| 200 | - $registered = true; |
|
| 201 | - } |
|
| 202 | - } |
|
| 203 | - // now add our two lists of dependencies together. |
|
| 204 | - // using Union (+=) favours the arrays in precedence from left to right, |
|
| 205 | - // so $dependencies is NOT overwritten because it is listed first |
|
| 206 | - // ie: with A = B + C, entries in B take precedence over duplicate entries in C |
|
| 207 | - // Union is way faster than array_merge() but should be used with caution... |
|
| 208 | - // especially with numerically indexed arrays |
|
| 209 | - $dependencies += self::$_instance->_dependency_map[ $class ]; |
|
| 210 | - // now we need to ensure that the resulting dependencies |
|
| 211 | - // array only has the entries that are required for the class |
|
| 212 | - // so first count how many dependencies were originally registered for the class |
|
| 213 | - $dependency_count = count(self::$_instance->_dependency_map[ $class ]); |
|
| 214 | - // if that count is non-zero (meaning dependencies were already registered) |
|
| 215 | - self::$_instance->_dependency_map[ $class ] = $dependency_count |
|
| 216 | - // then truncate the final array to match that count |
|
| 217 | - ? array_slice($dependencies, 0, $dependency_count) |
|
| 218 | - // otherwise just take the incoming array because nothing previously existed |
|
| 219 | - : $dependencies; |
|
| 220 | - return $registered; |
|
| 221 | - } |
|
| 222 | - |
|
| 223 | - |
|
| 224 | - |
|
| 225 | - /** |
|
| 226 | - * @param string $class_name |
|
| 227 | - * @param string $loader |
|
| 228 | - * @return bool |
|
| 229 | - * @throws DomainException |
|
| 230 | - */ |
|
| 231 | - public static function register_class_loader($class_name, $loader = 'load_core') |
|
| 232 | - { |
|
| 233 | - if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) { |
|
| 234 | - throw new DomainException( |
|
| 235 | - esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso') |
|
| 236 | - ); |
|
| 237 | - } |
|
| 238 | - // check that loader is callable or method starts with "load_" and exists in EE_Registry |
|
| 239 | - if ( |
|
| 240 | - ! is_callable($loader) |
|
| 241 | - && ( |
|
| 242 | - strpos($loader, 'load_') !== 0 |
|
| 243 | - || ! method_exists('EE_Registry', $loader) |
|
| 244 | - ) |
|
| 245 | - ) { |
|
| 246 | - throw new DomainException( |
|
| 247 | - sprintf( |
|
| 248 | - esc_html__( |
|
| 249 | - '"%1$s" is not a valid loader method on EE_Registry.', |
|
| 250 | - 'event_espresso' |
|
| 251 | - ), |
|
| 252 | - $loader |
|
| 253 | - ) |
|
| 254 | - ); |
|
| 255 | - } |
|
| 256 | - $class_name = self::$_instance->get_alias($class_name); |
|
| 257 | - if (! isset(self::$_instance->_class_loaders[$class_name])) { |
|
| 258 | - self::$_instance->_class_loaders[$class_name] = $loader; |
|
| 259 | - return true; |
|
| 260 | - } |
|
| 261 | - return false; |
|
| 262 | - } |
|
| 263 | - |
|
| 264 | - |
|
| 265 | - |
|
| 266 | - /** |
|
| 267 | - * @return array |
|
| 268 | - */ |
|
| 269 | - public function dependency_map() |
|
| 270 | - { |
|
| 271 | - return $this->_dependency_map; |
|
| 272 | - } |
|
| 273 | - |
|
| 274 | - |
|
| 275 | - |
|
| 276 | - /** |
|
| 277 | - * returns TRUE if dependency map contains a listing for the provided class name |
|
| 278 | - * |
|
| 279 | - * @param string $class_name |
|
| 280 | - * @return boolean |
|
| 281 | - */ |
|
| 282 | - public function has($class_name = '') |
|
| 283 | - { |
|
| 284 | - return isset($this->_dependency_map[$class_name]) ? true : false; |
|
| 285 | - } |
|
| 286 | - |
|
| 287 | - |
|
| 288 | - |
|
| 289 | - /** |
|
| 290 | - * returns TRUE if dependency map contains a listing for the provided class name AND dependency |
|
| 291 | - * |
|
| 292 | - * @param string $class_name |
|
| 293 | - * @param string $dependency |
|
| 294 | - * @return bool |
|
| 295 | - */ |
|
| 296 | - public function has_dependency_for_class($class_name = '', $dependency = '') |
|
| 297 | - { |
|
| 298 | - $dependency = $this->get_alias($dependency); |
|
| 299 | - return isset($this->_dependency_map[$class_name], $this->_dependency_map[$class_name][$dependency]) |
|
| 300 | - ? true |
|
| 301 | - : false; |
|
| 302 | - } |
|
| 303 | - |
|
| 304 | - |
|
| 305 | - |
|
| 306 | - /** |
|
| 307 | - * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned |
|
| 308 | - * |
|
| 309 | - * @param string $class_name |
|
| 310 | - * @param string $dependency |
|
| 311 | - * @return int |
|
| 312 | - */ |
|
| 313 | - public function loading_strategy_for_class_dependency($class_name = '', $dependency = '') |
|
| 314 | - { |
|
| 315 | - $dependency = $this->get_alias($dependency); |
|
| 316 | - return $this->has_dependency_for_class($class_name, $dependency) |
|
| 317 | - ? $this->_dependency_map[$class_name][$dependency] |
|
| 318 | - : EE_Dependency_Map::not_registered; |
|
| 319 | - } |
|
| 320 | - |
|
| 321 | - |
|
| 322 | - |
|
| 323 | - /** |
|
| 324 | - * @param string $class_name |
|
| 325 | - * @return string | Closure |
|
| 326 | - */ |
|
| 327 | - public function class_loader($class_name) |
|
| 328 | - { |
|
| 329 | - $class_name = $this->get_alias($class_name); |
|
| 330 | - return isset($this->_class_loaders[$class_name]) ? $this->_class_loaders[$class_name] : ''; |
|
| 331 | - } |
|
| 332 | - |
|
| 333 | - |
|
| 334 | - |
|
| 335 | - /** |
|
| 336 | - * @return array |
|
| 337 | - */ |
|
| 338 | - public function class_loaders() |
|
| 339 | - { |
|
| 340 | - return $this->_class_loaders; |
|
| 341 | - } |
|
| 342 | - |
|
| 343 | - |
|
| 344 | - |
|
| 345 | - /** |
|
| 346 | - * adds an alias for a classname |
|
| 347 | - * |
|
| 348 | - * @param string $class_name the class name that should be used (concrete class to replace interface) |
|
| 349 | - * @param string $alias the class name that would be type hinted for (abstract parent or interface) |
|
| 350 | - * @param string $for_class the class that has the dependency (is type hinting for the interface) |
|
| 351 | - */ |
|
| 352 | - public function add_alias($class_name, $alias, $for_class = '') |
|
| 353 | - { |
|
| 354 | - if ($for_class !== '') { |
|
| 355 | - if (! isset($this->_aliases[$for_class])) { |
|
| 356 | - $this->_aliases[$for_class] = array(); |
|
| 357 | - } |
|
| 358 | - $this->_aliases[$for_class][$class_name] = $alias; |
|
| 359 | - } |
|
| 360 | - $this->_aliases[$class_name] = $alias; |
|
| 361 | - } |
|
| 362 | - |
|
| 363 | - |
|
| 364 | - |
|
| 365 | - /** |
|
| 366 | - * returns TRUE if the provided class name has an alias |
|
| 367 | - * |
|
| 368 | - * @param string $class_name |
|
| 369 | - * @param string $for_class |
|
| 370 | - * @return bool |
|
| 371 | - */ |
|
| 372 | - public function has_alias($class_name = '', $for_class = '') |
|
| 373 | - { |
|
| 374 | - return isset($this->_aliases[$for_class], $this->_aliases[$for_class][$class_name]) |
|
| 375 | - || ( |
|
| 376 | - isset($this->_aliases[$class_name]) |
|
| 377 | - && ! is_array($this->_aliases[$class_name]) |
|
| 378 | - ); |
|
| 379 | - } |
|
| 380 | - |
|
| 381 | - |
|
| 382 | - |
|
| 383 | - /** |
|
| 384 | - * returns alias for class name if one exists, otherwise returns the original classname |
|
| 385 | - * functions recursively, so that multiple aliases can be used to drill down to a classname |
|
| 386 | - * for example: |
|
| 387 | - * if the following two entries were added to the _aliases array: |
|
| 388 | - * array( |
|
| 389 | - * 'interface_alias' => 'some\namespace\interface' |
|
| 390 | - * 'some\namespace\interface' => 'some\namespace\classname' |
|
| 391 | - * ) |
|
| 392 | - * then one could use EE_Registry::instance()->create( 'interface_alias' ) |
|
| 393 | - * to load an instance of 'some\namespace\classname' |
|
| 394 | - * |
|
| 395 | - * @param string $class_name |
|
| 396 | - * @param string $for_class |
|
| 397 | - * @return string |
|
| 398 | - */ |
|
| 399 | - public function get_alias($class_name = '', $for_class = '') |
|
| 400 | - { |
|
| 401 | - if (! $this->has_alias($class_name, $for_class)) { |
|
| 402 | - return $class_name; |
|
| 403 | - } |
|
| 404 | - if ($for_class !== '' && isset($this->_aliases[ $for_class ][ $class_name ])) { |
|
| 405 | - return $this->get_alias($this->_aliases[$for_class][$class_name], $for_class); |
|
| 406 | - } |
|
| 407 | - return $this->get_alias($this->_aliases[$class_name]); |
|
| 408 | - } |
|
| 409 | - |
|
| 410 | - |
|
| 411 | - |
|
| 412 | - /** |
|
| 413 | - * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache, |
|
| 414 | - * if one exists, or whether a new object should be generated every time the requested class is loaded. |
|
| 415 | - * This is done by using the following class constants: |
|
| 416 | - * EE_Dependency_Map::load_from_cache - loads previously instantiated object |
|
| 417 | - * EE_Dependency_Map::load_new_object - generates a new object every time |
|
| 418 | - */ |
|
| 419 | - protected function _register_core_dependencies() |
|
| 420 | - { |
|
| 421 | - $this->_dependency_map = array( |
|
| 422 | - 'EE_Request_Handler' => array( |
|
| 423 | - 'EE_Request' => EE_Dependency_Map::load_from_cache, |
|
| 424 | - ), |
|
| 425 | - 'EE_System' => array( |
|
| 426 | - 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
| 427 | - ), |
|
| 428 | - 'EE_Session' => array( |
|
| 429 | - 'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache, |
|
| 430 | - 'EE_Encryption' => EE_Dependency_Map::load_from_cache, |
|
| 431 | - ), |
|
| 432 | - 'EE_Cart' => array( |
|
| 433 | - 'EE_Session' => EE_Dependency_Map::load_from_cache, |
|
| 434 | - ), |
|
| 435 | - 'EE_Front_Controller' => array( |
|
| 436 | - 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
| 437 | - 'EE_Request_Handler' => EE_Dependency_Map::load_from_cache, |
|
| 438 | - 'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache, |
|
| 439 | - ), |
|
| 440 | - 'EE_Messenger_Collection_Loader' => array( |
|
| 441 | - 'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object, |
|
| 442 | - ), |
|
| 443 | - 'EE_Message_Type_Collection_Loader' => array( |
|
| 444 | - 'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object, |
|
| 445 | - ), |
|
| 446 | - 'EE_Message_Resource_Manager' => array( |
|
| 447 | - 'EE_Messenger_Collection_Loader' => EE_Dependency_Map::load_new_object, |
|
| 448 | - 'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object, |
|
| 449 | - 'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache, |
|
| 450 | - ), |
|
| 451 | - 'EE_Message_Factory' => array( |
|
| 452 | - 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
| 453 | - ), |
|
| 454 | - 'EE_messages' => array( |
|
| 455 | - 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
| 456 | - ), |
|
| 457 | - 'EE_Messages_Generator' => array( |
|
| 458 | - 'EE_Messages_Queue' => EE_Dependency_Map::load_new_object, |
|
| 459 | - 'EE_Messages_Data_Handler_Collection' => EE_Dependency_Map::load_new_object, |
|
| 460 | - 'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object, |
|
| 461 | - 'EEH_Parse_Shortcodes' => EE_Dependency_Map::load_from_cache, |
|
| 462 | - ), |
|
| 463 | - 'EE_Messages_Processor' => array( |
|
| 464 | - 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
| 465 | - ), |
|
| 466 | - 'EE_Messages_Queue' => array( |
|
| 467 | - 'EE_Message_Repository' => EE_Dependency_Map::load_new_object, |
|
| 468 | - ), |
|
| 469 | - 'EE_Messages_Template_Defaults' => array( |
|
| 470 | - 'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache, |
|
| 471 | - 'EEM_Message_Template' => EE_Dependency_Map::load_from_cache, |
|
| 472 | - ), |
|
| 473 | - 'EE_Message_To_Generate_From_Request' => array( |
|
| 474 | - 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
| 475 | - 'EE_Request_Handler' => EE_Dependency_Map::load_from_cache, |
|
| 476 | - ), |
|
| 477 | - 'EventEspresso\core\services\commands\CommandBus' => array( |
|
| 478 | - 'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache, |
|
| 479 | - ), |
|
| 480 | - 'EventEspresso\services\commands\CommandHandler' => array( |
|
| 481 | - 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
| 482 | - 'CommandBusInterface' => EE_Dependency_Map::load_from_cache, |
|
| 483 | - ), |
|
| 484 | - 'EventEspresso\core\services\commands\CommandHandlerManager' => array( |
|
| 485 | - 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 486 | - ), |
|
| 487 | - 'EventEspresso\core\services\commands\CompositeCommandHandler' => array( |
|
| 488 | - 'EventEspresso\core\services\commands\CommandBus' => EE_Dependency_Map::load_from_cache, |
|
| 489 | - 'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache, |
|
| 490 | - ), |
|
| 491 | - 'EventEspresso\core\services\commands\CommandFactory' => array( |
|
| 492 | - 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 493 | - ), |
|
| 494 | - 'EventEspresso\core\services\commands\middleware\CapChecker' => array( |
|
| 495 | - 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache, |
|
| 496 | - ), |
|
| 497 | - 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => array( |
|
| 498 | - 'EE_Capabilities' => EE_Dependency_Map::load_from_cache, |
|
| 499 | - ), |
|
| 500 | - 'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker' => array( |
|
| 501 | - 'EE_Capabilities' => EE_Dependency_Map::load_from_cache, |
|
| 502 | - ), |
|
| 503 | - 'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler' => array( |
|
| 504 | - 'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
| 505 | - ), |
|
| 506 | - 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler' => array( |
|
| 507 | - 'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
| 508 | - ), |
|
| 509 | - 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler' => array( |
|
| 510 | - 'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
| 511 | - ), |
|
| 512 | - 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler' => array( |
|
| 513 | - 'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
| 514 | - ), |
|
| 515 | - 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array( |
|
| 516 | - 'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
| 517 | - ), |
|
| 518 | - 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler' => array( |
|
| 519 | - 'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
| 520 | - ), |
|
| 521 | - 'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler' => array( |
|
| 522 | - 'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
| 523 | - ), |
|
| 524 | - 'EventEspresso\core\domain\services\registration\CancelRegistrationService' => array( |
|
| 525 | - 'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
| 526 | - ), |
|
| 527 | - 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler' => array( |
|
| 528 | - 'EEM_Attendee' => EE_Dependency_Map::load_from_cache, |
|
| 529 | - ), |
|
| 530 | - 'EventEspresso\core\services\database\TableManager' => array( |
|
| 531 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 532 | - ), |
|
| 533 | - 'EE_Data_Migration_Class_Base' => array( |
|
| 534 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 535 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 536 | - ), |
|
| 537 | - 'EE_DMS_Core_4_1_0' => array( |
|
| 538 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 539 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 540 | - ), |
|
| 541 | - 'EE_DMS_Core_4_2_0' => array( |
|
| 542 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 543 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 544 | - ), |
|
| 545 | - 'EE_DMS_Core_4_3_0' => array( |
|
| 546 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 547 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 548 | - ), |
|
| 549 | - 'EE_DMS_Core_4_4_0' => array( |
|
| 550 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 551 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 552 | - ), |
|
| 553 | - 'EE_DMS_Core_4_5_0' => array( |
|
| 554 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 555 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 556 | - ), |
|
| 557 | - 'EE_DMS_Core_4_6_0' => array( |
|
| 558 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 559 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 560 | - ), |
|
| 561 | - 'EE_DMS_Core_4_7_0' => array( |
|
| 562 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 563 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 564 | - ), |
|
| 565 | - 'EE_DMS_Core_4_8_0' => array( |
|
| 566 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 567 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 568 | - ), |
|
| 569 | - 'EE_DMS_Core_4_9_0' => array( |
|
| 570 | - 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 571 | - 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 572 | - ), |
|
| 573 | - 'EventEspresso\core\services\assets\Registry' => array( |
|
| 574 | - 'EE_Template_Config' => EE_Dependency_Map::load_from_cache, |
|
| 575 | - 'EE_Currency_Config' => EE_Dependency_Map::load_from_cache, |
|
| 576 | - ), |
|
| 577 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled' => array( |
|
| 578 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 579 | - ), |
|
| 580 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout' => array( |
|
| 581 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 582 | - ), |
|
| 583 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees' => array( |
|
| 584 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 585 | - ), |
|
| 586 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoEvents' => array( |
|
| 587 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 588 | - ), |
|
| 589 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou' => array( |
|
| 590 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 591 | - ), |
|
| 592 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector' => array( |
|
| 593 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 594 | - ), |
|
| 595 | - 'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage' => array( |
|
| 596 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 597 | - ), |
|
| 598 | - 'EventEspresso\core\services\cache\BasicCacheManager' => array( |
|
| 599 | - 'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache, |
|
| 600 | - ), |
|
| 601 | - 'EventEspresso\core\services\cache\PostRelatedCacheManager' => array( |
|
| 602 | - 'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache, |
|
| 603 | - ), |
|
| 604 | - ); |
|
| 605 | - } |
|
| 606 | - |
|
| 607 | - |
|
| 608 | - |
|
| 609 | - /** |
|
| 610 | - * Registers how core classes are loaded. |
|
| 611 | - * This can either be done by simply providing the name of one of the EE_Registry loader methods such as: |
|
| 612 | - * 'EE_Request_Handler' => 'load_core' |
|
| 613 | - * 'EE_Messages_Queue' => 'load_lib' |
|
| 614 | - * 'EEH_Debug_Tools' => 'load_helper' |
|
| 615 | - * or, if greater control is required, by providing a custom closure. For example: |
|
| 616 | - * 'Some_Class' => function () { |
|
| 617 | - * return new Some_Class(); |
|
| 618 | - * }, |
|
| 619 | - * This is required for instantiating dependencies |
|
| 620 | - * where an interface has been type hinted in a class constructor. For example: |
|
| 621 | - * 'Required_Interface' => function () { |
|
| 622 | - * return new A_Class_That_Implements_Required_Interface(); |
|
| 623 | - * }, |
|
| 624 | - */ |
|
| 625 | - protected function _register_core_class_loaders() |
|
| 626 | - { |
|
| 627 | - //for PHP5.3 compat, we need to register any properties called here in a variable because `$this` cannot |
|
| 628 | - //be used in a closure. |
|
| 629 | - $request = &$this->_request; |
|
| 630 | - $response = &$this->_response; |
|
| 631 | - $loader = &$this->loader; |
|
| 632 | - $this->_class_loaders = array( |
|
| 633 | - //load_core |
|
| 634 | - 'EE_Capabilities' => 'load_core', |
|
| 635 | - 'EE_Encryption' => 'load_core', |
|
| 636 | - 'EE_Front_Controller' => 'load_core', |
|
| 637 | - 'EE_Module_Request_Router' => 'load_core', |
|
| 638 | - 'EE_Registry' => 'load_core', |
|
| 639 | - 'EE_Request' => function () use (&$request) { |
|
| 640 | - return $request; |
|
| 641 | - }, |
|
| 642 | - 'EE_Response' => function () use (&$response) { |
|
| 643 | - return $response; |
|
| 644 | - }, |
|
| 645 | - 'EE_Request_Handler' => 'load_core', |
|
| 646 | - 'EE_Session' => 'load_core', |
|
| 647 | - //load_lib |
|
| 648 | - 'EE_Message_Resource_Manager' => 'load_lib', |
|
| 649 | - 'EE_Message_Type_Collection' => 'load_lib', |
|
| 650 | - 'EE_Message_Type_Collection_Loader' => 'load_lib', |
|
| 651 | - 'EE_Messenger_Collection' => 'load_lib', |
|
| 652 | - 'EE_Messenger_Collection_Loader' => 'load_lib', |
|
| 653 | - 'EE_Messages_Processor' => 'load_lib', |
|
| 654 | - 'EE_Message_Repository' => 'load_lib', |
|
| 655 | - 'EE_Messages_Queue' => 'load_lib', |
|
| 656 | - 'EE_Messages_Data_Handler_Collection' => 'load_lib', |
|
| 657 | - 'EE_Message_Template_Group_Collection' => 'load_lib', |
|
| 658 | - 'EE_Messages_Generator' => function () { |
|
| 659 | - return EE_Registry::instance()->load_lib( |
|
| 660 | - 'Messages_Generator', |
|
| 661 | - array(), |
|
| 662 | - false, |
|
| 663 | - false |
|
| 664 | - ); |
|
| 665 | - }, |
|
| 666 | - 'EE_Messages_Template_Defaults' => function ($arguments = array()) { |
|
| 667 | - return EE_Registry::instance()->load_lib( |
|
| 668 | - 'Messages_Template_Defaults', |
|
| 669 | - $arguments, |
|
| 670 | - false, |
|
| 671 | - false |
|
| 672 | - ); |
|
| 673 | - }, |
|
| 674 | - //load_model |
|
| 675 | - 'EEM_Attendee' => 'load_model', |
|
| 676 | - 'EEM_Message_Template_Group' => 'load_model', |
|
| 677 | - 'EEM_Message_Template' => 'load_model', |
|
| 678 | - //load_helper |
|
| 679 | - 'EEH_Parse_Shortcodes' => function () { |
|
| 680 | - if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) { |
|
| 681 | - return new EEH_Parse_Shortcodes(); |
|
| 682 | - } |
|
| 683 | - return null; |
|
| 684 | - }, |
|
| 685 | - 'EE_Template_Config' => function () { |
|
| 686 | - return EE_Config::instance()->template_settings; |
|
| 687 | - }, |
|
| 688 | - 'EE_Currency_Config' => function () { |
|
| 689 | - return EE_Config::instance()->currency; |
|
| 690 | - }, |
|
| 691 | - 'EventEspresso\core\services\loaders\Loader' => function () use (&$loader) { |
|
| 692 | - return $loader; |
|
| 693 | - }, |
|
| 694 | - ); |
|
| 695 | - } |
|
| 696 | - |
|
| 697 | - |
|
| 698 | - |
|
| 699 | - /** |
|
| 700 | - * can be used for supplying alternate names for classes, |
|
| 701 | - * or for connecting interface names to instantiable classes |
|
| 702 | - */ |
|
| 703 | - protected function _register_core_aliases() |
|
| 704 | - { |
|
| 705 | - $this->_aliases = array( |
|
| 706 | - 'CommandBusInterface' => 'EventEspresso\core\services\commands\CommandBusInterface', |
|
| 707 | - 'EventEspresso\core\services\commands\CommandBusInterface' => 'EventEspresso\core\services\commands\CommandBus', |
|
| 708 | - 'CommandHandlerManagerInterface' => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface', |
|
| 709 | - 'EventEspresso\core\services\commands\CommandHandlerManagerInterface' => 'EventEspresso\core\services\commands\CommandHandlerManager', |
|
| 710 | - 'CapChecker' => 'EventEspresso\core\services\commands\middleware\CapChecker', |
|
| 711 | - 'AddActionHook' => 'EventEspresso\core\services\commands\middleware\AddActionHook', |
|
| 712 | - 'CapabilitiesChecker' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker', |
|
| 713 | - 'CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface', |
|
| 714 | - 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker', |
|
| 715 | - 'CreateRegistrationService' => 'EventEspresso\core\domain\services\registration\CreateRegistrationService', |
|
| 716 | - 'CreateRegCodeCommandHandler' => 'EventEspresso\core\services\commands\registration\CreateRegCodeCommand', |
|
| 717 | - 'CreateRegUrlLinkCommandHandler' => 'EventEspresso\core\services\commands\registration\CreateRegUrlLinkCommand', |
|
| 718 | - 'CreateRegistrationCommandHandler' => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand', |
|
| 719 | - 'CopyRegistrationDetailsCommandHandler' => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand', |
|
| 720 | - 'CopyRegistrationPaymentsCommandHandler' => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand', |
|
| 721 | - 'CancelRegistrationAndTicketLineItemCommandHandler' => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler', |
|
| 722 | - 'UpdateRegistrationAndTransactionAfterChangeCommandHandler' => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler', |
|
| 723 | - 'CreateTicketLineItemCommandHandler' => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand', |
|
| 724 | - 'TableManager' => 'EventEspresso\core\services\database\TableManager', |
|
| 725 | - 'TableAnalysis' => 'EventEspresso\core\services\database\TableAnalysis', |
|
| 726 | - 'CreateTransactionCommandHandler' => 'EventEspresso\core\services\commands\transaction\CreateTransactionCommandHandler', |
|
| 727 | - 'CreateAttendeeCommandHandler' => 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler', |
|
| 728 | - 'EspressoShortcode' => 'EventEspresso\core\services\shortcodes\EspressoShortcode', |
|
| 729 | - 'ShortcodeInterface' => 'EventEspresso\core\services\shortcodes\ShortcodeInterface', |
|
| 730 | - 'EventEspresso\core\services\shortcodes\ShortcodeInterface' => 'EventEspresso\core\services\shortcodes\EspressoShortcode', |
|
| 731 | - 'EventEspresso\core\services\cache\CacheStorageInterface' => 'EventEspresso\core\services\cache\TransientCacheStorage', |
|
| 732 | - 'LoaderInterface' => 'EventEspresso\core\services\loaders\LoaderInterface', |
|
| 733 | - 'EventEspresso\core\services\loaders\LoaderInterface' => 'EventEspresso\core\services\loaders\Loader', |
|
| 734 | - 'CommandFactoryInterface' => 'EventEspresso\core\services\commands\CommandFactoryInterface', |
|
| 735 | - 'EventEspresso\core\services\commands\CommandFactoryInterface' => 'EventEspresso\core\services\commands\CommandFactory', |
|
| 736 | - 'EventEspresso\core\domain\services\session\SessionIdentifierInterface' => 'EE_Session', |
|
| 737 | - 'NoticeConverterInterface' => 'EventEspresso\core\services\notices\NoticeConverterInterface', |
|
| 738 | - 'EventEspresso\core\services\notices\NoticeConverterInterface' => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors', |
|
| 739 | - 'NoticesContainerInterface' => 'EventEspresso\core\services\notices\NoticesContainerInterface', |
|
| 740 | - 'EventEspresso\core\services\notices\NoticesContainerInterface' => 'EventEspresso\core\services\notices\NoticesContainer', |
|
| 741 | - ); |
|
| 742 | - } |
|
| 743 | - |
|
| 744 | - |
|
| 745 | - |
|
| 746 | - /** |
|
| 747 | - * This is used to reset the internal map and class_loaders to their original default state at the beginning of the |
|
| 748 | - * request Primarily used by unit tests. |
|
| 749 | - */ |
|
| 750 | - public function reset() |
|
| 751 | - { |
|
| 752 | - $this->_register_core_class_loaders(); |
|
| 753 | - $this->_register_core_dependencies(); |
|
| 754 | - } |
|
| 24 | + /** |
|
| 25 | + * This means that the requested class dependency is not present in the dependency map |
|
| 26 | + */ |
|
| 27 | + const not_registered = 0; |
|
| 28 | + |
|
| 29 | + /** |
|
| 30 | + * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class. |
|
| 31 | + */ |
|
| 32 | + const load_new_object = 1; |
|
| 33 | + |
|
| 34 | + /** |
|
| 35 | + * This instructs class loaders to return a previously instantiated and cached object for the requested class. |
|
| 36 | + * IF a previously instantiated object does not exist, a new one will be created and added to the cache. |
|
| 37 | + */ |
|
| 38 | + const load_from_cache = 2; |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * When registering a dependency, |
|
| 42 | + * this indicates to keep any existing dependencies that already exist, |
|
| 43 | + * and simply discard any new dependencies declared in the incoming data |
|
| 44 | + */ |
|
| 45 | + const KEEP_EXISTING_DEPENDENCIES = 0; |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * When registering a dependency, |
|
| 49 | + * this indicates to overwrite any existing dependencies that already exist using the incoming data |
|
| 50 | + */ |
|
| 51 | + const OVERWRITE_DEPENDENCIES = 1; |
|
| 52 | + |
|
| 53 | + |
|
| 54 | + |
|
| 55 | + /** |
|
| 56 | + * @type EE_Dependency_Map $_instance |
|
| 57 | + */ |
|
| 58 | + protected static $_instance; |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * @type EE_Request $request |
|
| 62 | + */ |
|
| 63 | + protected $_request; |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * @type EE_Response $response |
|
| 67 | + */ |
|
| 68 | + protected $_response; |
|
| 69 | + |
|
| 70 | + /** |
|
| 71 | + * @type LoaderInterface $loader |
|
| 72 | + */ |
|
| 73 | + protected $loader; |
|
| 74 | + |
|
| 75 | + /** |
|
| 76 | + * @type array $_dependency_map |
|
| 77 | + */ |
|
| 78 | + protected $_dependency_map = array(); |
|
| 79 | + |
|
| 80 | + /** |
|
| 81 | + * @type array $_class_loaders |
|
| 82 | + */ |
|
| 83 | + protected $_class_loaders = array(); |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * @type array $_aliases |
|
| 87 | + */ |
|
| 88 | + protected $_aliases = array(); |
|
| 89 | + |
|
| 90 | + |
|
| 91 | + |
|
| 92 | + /** |
|
| 93 | + * EE_Dependency_Map constructor. |
|
| 94 | + * |
|
| 95 | + * @param EE_Request $request |
|
| 96 | + * @param EE_Response $response |
|
| 97 | + */ |
|
| 98 | + protected function __construct(EE_Request $request, EE_Response $response) |
|
| 99 | + { |
|
| 100 | + $this->_request = $request; |
|
| 101 | + $this->_response = $response; |
|
| 102 | + add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize')); |
|
| 103 | + do_action('EE_Dependency_Map____construct'); |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + |
|
| 107 | + |
|
| 108 | + /** |
|
| 109 | + * @throws InvalidDataTypeException |
|
| 110 | + * @throws InvalidInterfaceException |
|
| 111 | + * @throws InvalidArgumentException |
|
| 112 | + */ |
|
| 113 | + public function initialize() |
|
| 114 | + { |
|
| 115 | + $this->_register_core_dependencies(); |
|
| 116 | + $this->_register_core_class_loaders(); |
|
| 117 | + $this->_register_core_aliases(); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + |
|
| 121 | + |
|
| 122 | + /** |
|
| 123 | + * @singleton method used to instantiate class object |
|
| 124 | + * @access public |
|
| 125 | + * @param EE_Request $request |
|
| 126 | + * @param EE_Response $response |
|
| 127 | + * @return EE_Dependency_Map |
|
| 128 | + */ |
|
| 129 | + public static function instance(EE_Request $request = null, EE_Response $response = null) |
|
| 130 | + { |
|
| 131 | + // check if class object is instantiated, and instantiated properly |
|
| 132 | + if (! self::$_instance instanceof EE_Dependency_Map) { |
|
| 133 | + self::$_instance = new EE_Dependency_Map($request, $response); |
|
| 134 | + } |
|
| 135 | + return self::$_instance; |
|
| 136 | + } |
|
| 137 | + |
|
| 138 | + |
|
| 139 | + |
|
| 140 | + /** |
|
| 141 | + * @param LoaderInterface $loader |
|
| 142 | + */ |
|
| 143 | + public function setLoader(LoaderInterface $loader) |
|
| 144 | + { |
|
| 145 | + $this->loader = $loader; |
|
| 146 | + } |
|
| 147 | + |
|
| 148 | + |
|
| 149 | + |
|
| 150 | + /** |
|
| 151 | + * @param string $class |
|
| 152 | + * @param array $dependencies |
|
| 153 | + * @param int $overwrite |
|
| 154 | + * @return bool |
|
| 155 | + */ |
|
| 156 | + public static function register_dependencies( |
|
| 157 | + $class, |
|
| 158 | + array $dependencies, |
|
| 159 | + $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES |
|
| 160 | + ) { |
|
| 161 | + return self::$_instance->registerDependencies($class, $dependencies, $overwrite); |
|
| 162 | + } |
|
| 163 | + |
|
| 164 | + |
|
| 165 | + |
|
| 166 | + /** |
|
| 167 | + * Assigns an array of class names and corresponding load sources (new or cached) |
|
| 168 | + * to the class specified by the first parameter. |
|
| 169 | + * IMPORTANT !!! |
|
| 170 | + * The order of elements in the incoming $dependencies array MUST match |
|
| 171 | + * the order of the constructor parameters for the class in question. |
|
| 172 | + * This is especially important when overriding any existing dependencies that are registered. |
|
| 173 | + * the third parameter controls whether any duplicate dependencies are overwritten or not. |
|
| 174 | + * |
|
| 175 | + * @param string $class |
|
| 176 | + * @param array $dependencies |
|
| 177 | + * @param int $overwrite |
|
| 178 | + * @return bool |
|
| 179 | + */ |
|
| 180 | + public function registerDependencies( |
|
| 181 | + $class, |
|
| 182 | + array $dependencies, |
|
| 183 | + $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES |
|
| 184 | + ) { |
|
| 185 | + $class = trim($class, '\\'); |
|
| 186 | + $registered = false; |
|
| 187 | + if (empty(self::$_instance->_dependency_map[ $class ])) { |
|
| 188 | + self::$_instance->_dependency_map[ $class ] = array(); |
|
| 189 | + } |
|
| 190 | + // we need to make sure that any aliases used when registering a dependency |
|
| 191 | + // get resolved to the correct class name |
|
| 192 | + foreach ((array)$dependencies as $dependency => $load_source) { |
|
| 193 | + $alias = self::$_instance->get_alias($dependency); |
|
| 194 | + if ( |
|
| 195 | + $overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES |
|
| 196 | + || ! isset(self::$_instance->_dependency_map[ $class ][ $alias ]) |
|
| 197 | + ) { |
|
| 198 | + unset($dependencies[$dependency]); |
|
| 199 | + $dependencies[$alias] = $load_source; |
|
| 200 | + $registered = true; |
|
| 201 | + } |
|
| 202 | + } |
|
| 203 | + // now add our two lists of dependencies together. |
|
| 204 | + // using Union (+=) favours the arrays in precedence from left to right, |
|
| 205 | + // so $dependencies is NOT overwritten because it is listed first |
|
| 206 | + // ie: with A = B + C, entries in B take precedence over duplicate entries in C |
|
| 207 | + // Union is way faster than array_merge() but should be used with caution... |
|
| 208 | + // especially with numerically indexed arrays |
|
| 209 | + $dependencies += self::$_instance->_dependency_map[ $class ]; |
|
| 210 | + // now we need to ensure that the resulting dependencies |
|
| 211 | + // array only has the entries that are required for the class |
|
| 212 | + // so first count how many dependencies were originally registered for the class |
|
| 213 | + $dependency_count = count(self::$_instance->_dependency_map[ $class ]); |
|
| 214 | + // if that count is non-zero (meaning dependencies were already registered) |
|
| 215 | + self::$_instance->_dependency_map[ $class ] = $dependency_count |
|
| 216 | + // then truncate the final array to match that count |
|
| 217 | + ? array_slice($dependencies, 0, $dependency_count) |
|
| 218 | + // otherwise just take the incoming array because nothing previously existed |
|
| 219 | + : $dependencies; |
|
| 220 | + return $registered; |
|
| 221 | + } |
|
| 222 | + |
|
| 223 | + |
|
| 224 | + |
|
| 225 | + /** |
|
| 226 | + * @param string $class_name |
|
| 227 | + * @param string $loader |
|
| 228 | + * @return bool |
|
| 229 | + * @throws DomainException |
|
| 230 | + */ |
|
| 231 | + public static function register_class_loader($class_name, $loader = 'load_core') |
|
| 232 | + { |
|
| 233 | + if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) { |
|
| 234 | + throw new DomainException( |
|
| 235 | + esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso') |
|
| 236 | + ); |
|
| 237 | + } |
|
| 238 | + // check that loader is callable or method starts with "load_" and exists in EE_Registry |
|
| 239 | + if ( |
|
| 240 | + ! is_callable($loader) |
|
| 241 | + && ( |
|
| 242 | + strpos($loader, 'load_') !== 0 |
|
| 243 | + || ! method_exists('EE_Registry', $loader) |
|
| 244 | + ) |
|
| 245 | + ) { |
|
| 246 | + throw new DomainException( |
|
| 247 | + sprintf( |
|
| 248 | + esc_html__( |
|
| 249 | + '"%1$s" is not a valid loader method on EE_Registry.', |
|
| 250 | + 'event_espresso' |
|
| 251 | + ), |
|
| 252 | + $loader |
|
| 253 | + ) |
|
| 254 | + ); |
|
| 255 | + } |
|
| 256 | + $class_name = self::$_instance->get_alias($class_name); |
|
| 257 | + if (! isset(self::$_instance->_class_loaders[$class_name])) { |
|
| 258 | + self::$_instance->_class_loaders[$class_name] = $loader; |
|
| 259 | + return true; |
|
| 260 | + } |
|
| 261 | + return false; |
|
| 262 | + } |
|
| 263 | + |
|
| 264 | + |
|
| 265 | + |
|
| 266 | + /** |
|
| 267 | + * @return array |
|
| 268 | + */ |
|
| 269 | + public function dependency_map() |
|
| 270 | + { |
|
| 271 | + return $this->_dependency_map; |
|
| 272 | + } |
|
| 273 | + |
|
| 274 | + |
|
| 275 | + |
|
| 276 | + /** |
|
| 277 | + * returns TRUE if dependency map contains a listing for the provided class name |
|
| 278 | + * |
|
| 279 | + * @param string $class_name |
|
| 280 | + * @return boolean |
|
| 281 | + */ |
|
| 282 | + public function has($class_name = '') |
|
| 283 | + { |
|
| 284 | + return isset($this->_dependency_map[$class_name]) ? true : false; |
|
| 285 | + } |
|
| 286 | + |
|
| 287 | + |
|
| 288 | + |
|
| 289 | + /** |
|
| 290 | + * returns TRUE if dependency map contains a listing for the provided class name AND dependency |
|
| 291 | + * |
|
| 292 | + * @param string $class_name |
|
| 293 | + * @param string $dependency |
|
| 294 | + * @return bool |
|
| 295 | + */ |
|
| 296 | + public function has_dependency_for_class($class_name = '', $dependency = '') |
|
| 297 | + { |
|
| 298 | + $dependency = $this->get_alias($dependency); |
|
| 299 | + return isset($this->_dependency_map[$class_name], $this->_dependency_map[$class_name][$dependency]) |
|
| 300 | + ? true |
|
| 301 | + : false; |
|
| 302 | + } |
|
| 303 | + |
|
| 304 | + |
|
| 305 | + |
|
| 306 | + /** |
|
| 307 | + * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned |
|
| 308 | + * |
|
| 309 | + * @param string $class_name |
|
| 310 | + * @param string $dependency |
|
| 311 | + * @return int |
|
| 312 | + */ |
|
| 313 | + public function loading_strategy_for_class_dependency($class_name = '', $dependency = '') |
|
| 314 | + { |
|
| 315 | + $dependency = $this->get_alias($dependency); |
|
| 316 | + return $this->has_dependency_for_class($class_name, $dependency) |
|
| 317 | + ? $this->_dependency_map[$class_name][$dependency] |
|
| 318 | + : EE_Dependency_Map::not_registered; |
|
| 319 | + } |
|
| 320 | + |
|
| 321 | + |
|
| 322 | + |
|
| 323 | + /** |
|
| 324 | + * @param string $class_name |
|
| 325 | + * @return string | Closure |
|
| 326 | + */ |
|
| 327 | + public function class_loader($class_name) |
|
| 328 | + { |
|
| 329 | + $class_name = $this->get_alias($class_name); |
|
| 330 | + return isset($this->_class_loaders[$class_name]) ? $this->_class_loaders[$class_name] : ''; |
|
| 331 | + } |
|
| 332 | + |
|
| 333 | + |
|
| 334 | + |
|
| 335 | + /** |
|
| 336 | + * @return array |
|
| 337 | + */ |
|
| 338 | + public function class_loaders() |
|
| 339 | + { |
|
| 340 | + return $this->_class_loaders; |
|
| 341 | + } |
|
| 342 | + |
|
| 343 | + |
|
| 344 | + |
|
| 345 | + /** |
|
| 346 | + * adds an alias for a classname |
|
| 347 | + * |
|
| 348 | + * @param string $class_name the class name that should be used (concrete class to replace interface) |
|
| 349 | + * @param string $alias the class name that would be type hinted for (abstract parent or interface) |
|
| 350 | + * @param string $for_class the class that has the dependency (is type hinting for the interface) |
|
| 351 | + */ |
|
| 352 | + public function add_alias($class_name, $alias, $for_class = '') |
|
| 353 | + { |
|
| 354 | + if ($for_class !== '') { |
|
| 355 | + if (! isset($this->_aliases[$for_class])) { |
|
| 356 | + $this->_aliases[$for_class] = array(); |
|
| 357 | + } |
|
| 358 | + $this->_aliases[$for_class][$class_name] = $alias; |
|
| 359 | + } |
|
| 360 | + $this->_aliases[$class_name] = $alias; |
|
| 361 | + } |
|
| 362 | + |
|
| 363 | + |
|
| 364 | + |
|
| 365 | + /** |
|
| 366 | + * returns TRUE if the provided class name has an alias |
|
| 367 | + * |
|
| 368 | + * @param string $class_name |
|
| 369 | + * @param string $for_class |
|
| 370 | + * @return bool |
|
| 371 | + */ |
|
| 372 | + public function has_alias($class_name = '', $for_class = '') |
|
| 373 | + { |
|
| 374 | + return isset($this->_aliases[$for_class], $this->_aliases[$for_class][$class_name]) |
|
| 375 | + || ( |
|
| 376 | + isset($this->_aliases[$class_name]) |
|
| 377 | + && ! is_array($this->_aliases[$class_name]) |
|
| 378 | + ); |
|
| 379 | + } |
|
| 380 | + |
|
| 381 | + |
|
| 382 | + |
|
| 383 | + /** |
|
| 384 | + * returns alias for class name if one exists, otherwise returns the original classname |
|
| 385 | + * functions recursively, so that multiple aliases can be used to drill down to a classname |
|
| 386 | + * for example: |
|
| 387 | + * if the following two entries were added to the _aliases array: |
|
| 388 | + * array( |
|
| 389 | + * 'interface_alias' => 'some\namespace\interface' |
|
| 390 | + * 'some\namespace\interface' => 'some\namespace\classname' |
|
| 391 | + * ) |
|
| 392 | + * then one could use EE_Registry::instance()->create( 'interface_alias' ) |
|
| 393 | + * to load an instance of 'some\namespace\classname' |
|
| 394 | + * |
|
| 395 | + * @param string $class_name |
|
| 396 | + * @param string $for_class |
|
| 397 | + * @return string |
|
| 398 | + */ |
|
| 399 | + public function get_alias($class_name = '', $for_class = '') |
|
| 400 | + { |
|
| 401 | + if (! $this->has_alias($class_name, $for_class)) { |
|
| 402 | + return $class_name; |
|
| 403 | + } |
|
| 404 | + if ($for_class !== '' && isset($this->_aliases[ $for_class ][ $class_name ])) { |
|
| 405 | + return $this->get_alias($this->_aliases[$for_class][$class_name], $for_class); |
|
| 406 | + } |
|
| 407 | + return $this->get_alias($this->_aliases[$class_name]); |
|
| 408 | + } |
|
| 409 | + |
|
| 410 | + |
|
| 411 | + |
|
| 412 | + /** |
|
| 413 | + * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache, |
|
| 414 | + * if one exists, or whether a new object should be generated every time the requested class is loaded. |
|
| 415 | + * This is done by using the following class constants: |
|
| 416 | + * EE_Dependency_Map::load_from_cache - loads previously instantiated object |
|
| 417 | + * EE_Dependency_Map::load_new_object - generates a new object every time |
|
| 418 | + */ |
|
| 419 | + protected function _register_core_dependencies() |
|
| 420 | + { |
|
| 421 | + $this->_dependency_map = array( |
|
| 422 | + 'EE_Request_Handler' => array( |
|
| 423 | + 'EE_Request' => EE_Dependency_Map::load_from_cache, |
|
| 424 | + ), |
|
| 425 | + 'EE_System' => array( |
|
| 426 | + 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
| 427 | + ), |
|
| 428 | + 'EE_Session' => array( |
|
| 429 | + 'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache, |
|
| 430 | + 'EE_Encryption' => EE_Dependency_Map::load_from_cache, |
|
| 431 | + ), |
|
| 432 | + 'EE_Cart' => array( |
|
| 433 | + 'EE_Session' => EE_Dependency_Map::load_from_cache, |
|
| 434 | + ), |
|
| 435 | + 'EE_Front_Controller' => array( |
|
| 436 | + 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
| 437 | + 'EE_Request_Handler' => EE_Dependency_Map::load_from_cache, |
|
| 438 | + 'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache, |
|
| 439 | + ), |
|
| 440 | + 'EE_Messenger_Collection_Loader' => array( |
|
| 441 | + 'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object, |
|
| 442 | + ), |
|
| 443 | + 'EE_Message_Type_Collection_Loader' => array( |
|
| 444 | + 'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object, |
|
| 445 | + ), |
|
| 446 | + 'EE_Message_Resource_Manager' => array( |
|
| 447 | + 'EE_Messenger_Collection_Loader' => EE_Dependency_Map::load_new_object, |
|
| 448 | + 'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object, |
|
| 449 | + 'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache, |
|
| 450 | + ), |
|
| 451 | + 'EE_Message_Factory' => array( |
|
| 452 | + 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
| 453 | + ), |
|
| 454 | + 'EE_messages' => array( |
|
| 455 | + 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
| 456 | + ), |
|
| 457 | + 'EE_Messages_Generator' => array( |
|
| 458 | + 'EE_Messages_Queue' => EE_Dependency_Map::load_new_object, |
|
| 459 | + 'EE_Messages_Data_Handler_Collection' => EE_Dependency_Map::load_new_object, |
|
| 460 | + 'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object, |
|
| 461 | + 'EEH_Parse_Shortcodes' => EE_Dependency_Map::load_from_cache, |
|
| 462 | + ), |
|
| 463 | + 'EE_Messages_Processor' => array( |
|
| 464 | + 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
| 465 | + ), |
|
| 466 | + 'EE_Messages_Queue' => array( |
|
| 467 | + 'EE_Message_Repository' => EE_Dependency_Map::load_new_object, |
|
| 468 | + ), |
|
| 469 | + 'EE_Messages_Template_Defaults' => array( |
|
| 470 | + 'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache, |
|
| 471 | + 'EEM_Message_Template' => EE_Dependency_Map::load_from_cache, |
|
| 472 | + ), |
|
| 473 | + 'EE_Message_To_Generate_From_Request' => array( |
|
| 474 | + 'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache, |
|
| 475 | + 'EE_Request_Handler' => EE_Dependency_Map::load_from_cache, |
|
| 476 | + ), |
|
| 477 | + 'EventEspresso\core\services\commands\CommandBus' => array( |
|
| 478 | + 'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache, |
|
| 479 | + ), |
|
| 480 | + 'EventEspresso\services\commands\CommandHandler' => array( |
|
| 481 | + 'EE_Registry' => EE_Dependency_Map::load_from_cache, |
|
| 482 | + 'CommandBusInterface' => EE_Dependency_Map::load_from_cache, |
|
| 483 | + ), |
|
| 484 | + 'EventEspresso\core\services\commands\CommandHandlerManager' => array( |
|
| 485 | + 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 486 | + ), |
|
| 487 | + 'EventEspresso\core\services\commands\CompositeCommandHandler' => array( |
|
| 488 | + 'EventEspresso\core\services\commands\CommandBus' => EE_Dependency_Map::load_from_cache, |
|
| 489 | + 'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache, |
|
| 490 | + ), |
|
| 491 | + 'EventEspresso\core\services\commands\CommandFactory' => array( |
|
| 492 | + 'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache, |
|
| 493 | + ), |
|
| 494 | + 'EventEspresso\core\services\commands\middleware\CapChecker' => array( |
|
| 495 | + 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache, |
|
| 496 | + ), |
|
| 497 | + 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => array( |
|
| 498 | + 'EE_Capabilities' => EE_Dependency_Map::load_from_cache, |
|
| 499 | + ), |
|
| 500 | + 'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker' => array( |
|
| 501 | + 'EE_Capabilities' => EE_Dependency_Map::load_from_cache, |
|
| 502 | + ), |
|
| 503 | + 'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler' => array( |
|
| 504 | + 'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
| 505 | + ), |
|
| 506 | + 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler' => array( |
|
| 507 | + 'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
| 508 | + ), |
|
| 509 | + 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler' => array( |
|
| 510 | + 'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
| 511 | + ), |
|
| 512 | + 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler' => array( |
|
| 513 | + 'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
| 514 | + ), |
|
| 515 | + 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array( |
|
| 516 | + 'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache, |
|
| 517 | + ), |
|
| 518 | + 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler' => array( |
|
| 519 | + 'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
| 520 | + ), |
|
| 521 | + 'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler' => array( |
|
| 522 | + 'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
| 523 | + ), |
|
| 524 | + 'EventEspresso\core\domain\services\registration\CancelRegistrationService' => array( |
|
| 525 | + 'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache, |
|
| 526 | + ), |
|
| 527 | + 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler' => array( |
|
| 528 | + 'EEM_Attendee' => EE_Dependency_Map::load_from_cache, |
|
| 529 | + ), |
|
| 530 | + 'EventEspresso\core\services\database\TableManager' => array( |
|
| 531 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 532 | + ), |
|
| 533 | + 'EE_Data_Migration_Class_Base' => array( |
|
| 534 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 535 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 536 | + ), |
|
| 537 | + 'EE_DMS_Core_4_1_0' => array( |
|
| 538 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 539 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 540 | + ), |
|
| 541 | + 'EE_DMS_Core_4_2_0' => array( |
|
| 542 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 543 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 544 | + ), |
|
| 545 | + 'EE_DMS_Core_4_3_0' => array( |
|
| 546 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 547 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 548 | + ), |
|
| 549 | + 'EE_DMS_Core_4_4_0' => array( |
|
| 550 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 551 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 552 | + ), |
|
| 553 | + 'EE_DMS_Core_4_5_0' => array( |
|
| 554 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 555 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 556 | + ), |
|
| 557 | + 'EE_DMS_Core_4_6_0' => array( |
|
| 558 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 559 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 560 | + ), |
|
| 561 | + 'EE_DMS_Core_4_7_0' => array( |
|
| 562 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 563 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 564 | + ), |
|
| 565 | + 'EE_DMS_Core_4_8_0' => array( |
|
| 566 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 567 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 568 | + ), |
|
| 569 | + 'EE_DMS_Core_4_9_0' => array( |
|
| 570 | + 'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache, |
|
| 571 | + 'EventEspresso\core\services\database\TableManager' => EE_Dependency_Map::load_from_cache, |
|
| 572 | + ), |
|
| 573 | + 'EventEspresso\core\services\assets\Registry' => array( |
|
| 574 | + 'EE_Template_Config' => EE_Dependency_Map::load_from_cache, |
|
| 575 | + 'EE_Currency_Config' => EE_Dependency_Map::load_from_cache, |
|
| 576 | + ), |
|
| 577 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled' => array( |
|
| 578 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 579 | + ), |
|
| 580 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout' => array( |
|
| 581 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 582 | + ), |
|
| 583 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees' => array( |
|
| 584 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 585 | + ), |
|
| 586 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoEvents' => array( |
|
| 587 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 588 | + ), |
|
| 589 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou' => array( |
|
| 590 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 591 | + ), |
|
| 592 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector' => array( |
|
| 593 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 594 | + ), |
|
| 595 | + 'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage' => array( |
|
| 596 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache, |
|
| 597 | + ), |
|
| 598 | + 'EventEspresso\core\services\cache\BasicCacheManager' => array( |
|
| 599 | + 'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache, |
|
| 600 | + ), |
|
| 601 | + 'EventEspresso\core\services\cache\PostRelatedCacheManager' => array( |
|
| 602 | + 'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache, |
|
| 603 | + ), |
|
| 604 | + ); |
|
| 605 | + } |
|
| 606 | + |
|
| 607 | + |
|
| 608 | + |
|
| 609 | + /** |
|
| 610 | + * Registers how core classes are loaded. |
|
| 611 | + * This can either be done by simply providing the name of one of the EE_Registry loader methods such as: |
|
| 612 | + * 'EE_Request_Handler' => 'load_core' |
|
| 613 | + * 'EE_Messages_Queue' => 'load_lib' |
|
| 614 | + * 'EEH_Debug_Tools' => 'load_helper' |
|
| 615 | + * or, if greater control is required, by providing a custom closure. For example: |
|
| 616 | + * 'Some_Class' => function () { |
|
| 617 | + * return new Some_Class(); |
|
| 618 | + * }, |
|
| 619 | + * This is required for instantiating dependencies |
|
| 620 | + * where an interface has been type hinted in a class constructor. For example: |
|
| 621 | + * 'Required_Interface' => function () { |
|
| 622 | + * return new A_Class_That_Implements_Required_Interface(); |
|
| 623 | + * }, |
|
| 624 | + */ |
|
| 625 | + protected function _register_core_class_loaders() |
|
| 626 | + { |
|
| 627 | + //for PHP5.3 compat, we need to register any properties called here in a variable because `$this` cannot |
|
| 628 | + //be used in a closure. |
|
| 629 | + $request = &$this->_request; |
|
| 630 | + $response = &$this->_response; |
|
| 631 | + $loader = &$this->loader; |
|
| 632 | + $this->_class_loaders = array( |
|
| 633 | + //load_core |
|
| 634 | + 'EE_Capabilities' => 'load_core', |
|
| 635 | + 'EE_Encryption' => 'load_core', |
|
| 636 | + 'EE_Front_Controller' => 'load_core', |
|
| 637 | + 'EE_Module_Request_Router' => 'load_core', |
|
| 638 | + 'EE_Registry' => 'load_core', |
|
| 639 | + 'EE_Request' => function () use (&$request) { |
|
| 640 | + return $request; |
|
| 641 | + }, |
|
| 642 | + 'EE_Response' => function () use (&$response) { |
|
| 643 | + return $response; |
|
| 644 | + }, |
|
| 645 | + 'EE_Request_Handler' => 'load_core', |
|
| 646 | + 'EE_Session' => 'load_core', |
|
| 647 | + //load_lib |
|
| 648 | + 'EE_Message_Resource_Manager' => 'load_lib', |
|
| 649 | + 'EE_Message_Type_Collection' => 'load_lib', |
|
| 650 | + 'EE_Message_Type_Collection_Loader' => 'load_lib', |
|
| 651 | + 'EE_Messenger_Collection' => 'load_lib', |
|
| 652 | + 'EE_Messenger_Collection_Loader' => 'load_lib', |
|
| 653 | + 'EE_Messages_Processor' => 'load_lib', |
|
| 654 | + 'EE_Message_Repository' => 'load_lib', |
|
| 655 | + 'EE_Messages_Queue' => 'load_lib', |
|
| 656 | + 'EE_Messages_Data_Handler_Collection' => 'load_lib', |
|
| 657 | + 'EE_Message_Template_Group_Collection' => 'load_lib', |
|
| 658 | + 'EE_Messages_Generator' => function () { |
|
| 659 | + return EE_Registry::instance()->load_lib( |
|
| 660 | + 'Messages_Generator', |
|
| 661 | + array(), |
|
| 662 | + false, |
|
| 663 | + false |
|
| 664 | + ); |
|
| 665 | + }, |
|
| 666 | + 'EE_Messages_Template_Defaults' => function ($arguments = array()) { |
|
| 667 | + return EE_Registry::instance()->load_lib( |
|
| 668 | + 'Messages_Template_Defaults', |
|
| 669 | + $arguments, |
|
| 670 | + false, |
|
| 671 | + false |
|
| 672 | + ); |
|
| 673 | + }, |
|
| 674 | + //load_model |
|
| 675 | + 'EEM_Attendee' => 'load_model', |
|
| 676 | + 'EEM_Message_Template_Group' => 'load_model', |
|
| 677 | + 'EEM_Message_Template' => 'load_model', |
|
| 678 | + //load_helper |
|
| 679 | + 'EEH_Parse_Shortcodes' => function () { |
|
| 680 | + if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) { |
|
| 681 | + return new EEH_Parse_Shortcodes(); |
|
| 682 | + } |
|
| 683 | + return null; |
|
| 684 | + }, |
|
| 685 | + 'EE_Template_Config' => function () { |
|
| 686 | + return EE_Config::instance()->template_settings; |
|
| 687 | + }, |
|
| 688 | + 'EE_Currency_Config' => function () { |
|
| 689 | + return EE_Config::instance()->currency; |
|
| 690 | + }, |
|
| 691 | + 'EventEspresso\core\services\loaders\Loader' => function () use (&$loader) { |
|
| 692 | + return $loader; |
|
| 693 | + }, |
|
| 694 | + ); |
|
| 695 | + } |
|
| 696 | + |
|
| 697 | + |
|
| 698 | + |
|
| 699 | + /** |
|
| 700 | + * can be used for supplying alternate names for classes, |
|
| 701 | + * or for connecting interface names to instantiable classes |
|
| 702 | + */ |
|
| 703 | + protected function _register_core_aliases() |
|
| 704 | + { |
|
| 705 | + $this->_aliases = array( |
|
| 706 | + 'CommandBusInterface' => 'EventEspresso\core\services\commands\CommandBusInterface', |
|
| 707 | + 'EventEspresso\core\services\commands\CommandBusInterface' => 'EventEspresso\core\services\commands\CommandBus', |
|
| 708 | + 'CommandHandlerManagerInterface' => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface', |
|
| 709 | + 'EventEspresso\core\services\commands\CommandHandlerManagerInterface' => 'EventEspresso\core\services\commands\CommandHandlerManager', |
|
| 710 | + 'CapChecker' => 'EventEspresso\core\services\commands\middleware\CapChecker', |
|
| 711 | + 'AddActionHook' => 'EventEspresso\core\services\commands\middleware\AddActionHook', |
|
| 712 | + 'CapabilitiesChecker' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker', |
|
| 713 | + 'CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface', |
|
| 714 | + 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker', |
|
| 715 | + 'CreateRegistrationService' => 'EventEspresso\core\domain\services\registration\CreateRegistrationService', |
|
| 716 | + 'CreateRegCodeCommandHandler' => 'EventEspresso\core\services\commands\registration\CreateRegCodeCommand', |
|
| 717 | + 'CreateRegUrlLinkCommandHandler' => 'EventEspresso\core\services\commands\registration\CreateRegUrlLinkCommand', |
|
| 718 | + 'CreateRegistrationCommandHandler' => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand', |
|
| 719 | + 'CopyRegistrationDetailsCommandHandler' => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand', |
|
| 720 | + 'CopyRegistrationPaymentsCommandHandler' => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand', |
|
| 721 | + 'CancelRegistrationAndTicketLineItemCommandHandler' => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler', |
|
| 722 | + 'UpdateRegistrationAndTransactionAfterChangeCommandHandler' => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler', |
|
| 723 | + 'CreateTicketLineItemCommandHandler' => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand', |
|
| 724 | + 'TableManager' => 'EventEspresso\core\services\database\TableManager', |
|
| 725 | + 'TableAnalysis' => 'EventEspresso\core\services\database\TableAnalysis', |
|
| 726 | + 'CreateTransactionCommandHandler' => 'EventEspresso\core\services\commands\transaction\CreateTransactionCommandHandler', |
|
| 727 | + 'CreateAttendeeCommandHandler' => 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler', |
|
| 728 | + 'EspressoShortcode' => 'EventEspresso\core\services\shortcodes\EspressoShortcode', |
|
| 729 | + 'ShortcodeInterface' => 'EventEspresso\core\services\shortcodes\ShortcodeInterface', |
|
| 730 | + 'EventEspresso\core\services\shortcodes\ShortcodeInterface' => 'EventEspresso\core\services\shortcodes\EspressoShortcode', |
|
| 731 | + 'EventEspresso\core\services\cache\CacheStorageInterface' => 'EventEspresso\core\services\cache\TransientCacheStorage', |
|
| 732 | + 'LoaderInterface' => 'EventEspresso\core\services\loaders\LoaderInterface', |
|
| 733 | + 'EventEspresso\core\services\loaders\LoaderInterface' => 'EventEspresso\core\services\loaders\Loader', |
|
| 734 | + 'CommandFactoryInterface' => 'EventEspresso\core\services\commands\CommandFactoryInterface', |
|
| 735 | + 'EventEspresso\core\services\commands\CommandFactoryInterface' => 'EventEspresso\core\services\commands\CommandFactory', |
|
| 736 | + 'EventEspresso\core\domain\services\session\SessionIdentifierInterface' => 'EE_Session', |
|
| 737 | + 'NoticeConverterInterface' => 'EventEspresso\core\services\notices\NoticeConverterInterface', |
|
| 738 | + 'EventEspresso\core\services\notices\NoticeConverterInterface' => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors', |
|
| 739 | + 'NoticesContainerInterface' => 'EventEspresso\core\services\notices\NoticesContainerInterface', |
|
| 740 | + 'EventEspresso\core\services\notices\NoticesContainerInterface' => 'EventEspresso\core\services\notices\NoticesContainer', |
|
| 741 | + ); |
|
| 742 | + } |
|
| 743 | + |
|
| 744 | + |
|
| 745 | + |
|
| 746 | + /** |
|
| 747 | + * This is used to reset the internal map and class_loaders to their original default state at the beginning of the |
|
| 748 | + * request Primarily used by unit tests. |
|
| 749 | + */ |
|
| 750 | + public function reset() |
|
| 751 | + { |
|
| 752 | + $this->_register_core_class_loaders(); |
|
| 753 | + $this->_register_core_dependencies(); |
|
| 754 | + } |
|
| 755 | 755 | |
| 756 | 756 | |
| 757 | 757 | } |
@@ -3,7 +3,7 @@ discard block |
||
| 3 | 3 | use EventEspresso\core\exceptions\InvalidInterfaceException; |
| 4 | 4 | use EventEspresso\core\services\loaders\LoaderInterface; |
| 5 | 5 | |
| 6 | -if (! defined('EVENT_ESPRESSO_VERSION')) { |
|
| 6 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
| 7 | 7 | exit('No direct script access allowed'); |
| 8 | 8 | } |
| 9 | 9 | |
@@ -129,7 +129,7 @@ discard block |
||
| 129 | 129 | public static function instance(EE_Request $request = null, EE_Response $response = null) |
| 130 | 130 | { |
| 131 | 131 | // check if class object is instantiated, and instantiated properly |
| 132 | - if (! self::$_instance instanceof EE_Dependency_Map) { |
|
| 132 | + if ( ! self::$_instance instanceof EE_Dependency_Map) { |
|
| 133 | 133 | self::$_instance = new EE_Dependency_Map($request, $response); |
| 134 | 134 | } |
| 135 | 135 | return self::$_instance; |
@@ -184,16 +184,16 @@ discard block |
||
| 184 | 184 | ) { |
| 185 | 185 | $class = trim($class, '\\'); |
| 186 | 186 | $registered = false; |
| 187 | - if (empty(self::$_instance->_dependency_map[ $class ])) { |
|
| 188 | - self::$_instance->_dependency_map[ $class ] = array(); |
|
| 187 | + if (empty(self::$_instance->_dependency_map[$class])) { |
|
| 188 | + self::$_instance->_dependency_map[$class] = array(); |
|
| 189 | 189 | } |
| 190 | 190 | // we need to make sure that any aliases used when registering a dependency |
| 191 | 191 | // get resolved to the correct class name |
| 192 | - foreach ((array)$dependencies as $dependency => $load_source) { |
|
| 192 | + foreach ((array) $dependencies as $dependency => $load_source) { |
|
| 193 | 193 | $alias = self::$_instance->get_alias($dependency); |
| 194 | 194 | if ( |
| 195 | 195 | $overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES |
| 196 | - || ! isset(self::$_instance->_dependency_map[ $class ][ $alias ]) |
|
| 196 | + || ! isset(self::$_instance->_dependency_map[$class][$alias]) |
|
| 197 | 197 | ) { |
| 198 | 198 | unset($dependencies[$dependency]); |
| 199 | 199 | $dependencies[$alias] = $load_source; |
@@ -206,13 +206,13 @@ discard block |
||
| 206 | 206 | // ie: with A = B + C, entries in B take precedence over duplicate entries in C |
| 207 | 207 | // Union is way faster than array_merge() but should be used with caution... |
| 208 | 208 | // especially with numerically indexed arrays |
| 209 | - $dependencies += self::$_instance->_dependency_map[ $class ]; |
|
| 209 | + $dependencies += self::$_instance->_dependency_map[$class]; |
|
| 210 | 210 | // now we need to ensure that the resulting dependencies |
| 211 | 211 | // array only has the entries that are required for the class |
| 212 | 212 | // so first count how many dependencies were originally registered for the class |
| 213 | - $dependency_count = count(self::$_instance->_dependency_map[ $class ]); |
|
| 213 | + $dependency_count = count(self::$_instance->_dependency_map[$class]); |
|
| 214 | 214 | // if that count is non-zero (meaning dependencies were already registered) |
| 215 | - self::$_instance->_dependency_map[ $class ] = $dependency_count |
|
| 215 | + self::$_instance->_dependency_map[$class] = $dependency_count |
|
| 216 | 216 | // then truncate the final array to match that count |
| 217 | 217 | ? array_slice($dependencies, 0, $dependency_count) |
| 218 | 218 | // otherwise just take the incoming array because nothing previously existed |
@@ -230,7 +230,7 @@ discard block |
||
| 230 | 230 | */ |
| 231 | 231 | public static function register_class_loader($class_name, $loader = 'load_core') |
| 232 | 232 | { |
| 233 | - if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) { |
|
| 233 | + if ( ! $loader instanceof Closure && strpos($class_name, '\\') !== false) { |
|
| 234 | 234 | throw new DomainException( |
| 235 | 235 | esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso') |
| 236 | 236 | ); |
@@ -254,7 +254,7 @@ discard block |
||
| 254 | 254 | ); |
| 255 | 255 | } |
| 256 | 256 | $class_name = self::$_instance->get_alias($class_name); |
| 257 | - if (! isset(self::$_instance->_class_loaders[$class_name])) { |
|
| 257 | + if ( ! isset(self::$_instance->_class_loaders[$class_name])) { |
|
| 258 | 258 | self::$_instance->_class_loaders[$class_name] = $loader; |
| 259 | 259 | return true; |
| 260 | 260 | } |
@@ -352,7 +352,7 @@ discard block |
||
| 352 | 352 | public function add_alias($class_name, $alias, $for_class = '') |
| 353 | 353 | { |
| 354 | 354 | if ($for_class !== '') { |
| 355 | - if (! isset($this->_aliases[$for_class])) { |
|
| 355 | + if ( ! isset($this->_aliases[$for_class])) { |
|
| 356 | 356 | $this->_aliases[$for_class] = array(); |
| 357 | 357 | } |
| 358 | 358 | $this->_aliases[$for_class][$class_name] = $alias; |
@@ -398,10 +398,10 @@ discard block |
||
| 398 | 398 | */ |
| 399 | 399 | public function get_alias($class_name = '', $for_class = '') |
| 400 | 400 | { |
| 401 | - if (! $this->has_alias($class_name, $for_class)) { |
|
| 401 | + if ( ! $this->has_alias($class_name, $for_class)) { |
|
| 402 | 402 | return $class_name; |
| 403 | 403 | } |
| 404 | - if ($for_class !== '' && isset($this->_aliases[ $for_class ][ $class_name ])) { |
|
| 404 | + if ($for_class !== '' && isset($this->_aliases[$for_class][$class_name])) { |
|
| 405 | 405 | return $this->get_alias($this->_aliases[$for_class][$class_name], $for_class); |
| 406 | 406 | } |
| 407 | 407 | return $this->get_alias($this->_aliases[$class_name]); |
@@ -636,10 +636,10 @@ discard block |
||
| 636 | 636 | 'EE_Front_Controller' => 'load_core', |
| 637 | 637 | 'EE_Module_Request_Router' => 'load_core', |
| 638 | 638 | 'EE_Registry' => 'load_core', |
| 639 | - 'EE_Request' => function () use (&$request) { |
|
| 639 | + 'EE_Request' => function() use (&$request) { |
|
| 640 | 640 | return $request; |
| 641 | 641 | }, |
| 642 | - 'EE_Response' => function () use (&$response) { |
|
| 642 | + 'EE_Response' => function() use (&$response) { |
|
| 643 | 643 | return $response; |
| 644 | 644 | }, |
| 645 | 645 | 'EE_Request_Handler' => 'load_core', |
@@ -655,7 +655,7 @@ discard block |
||
| 655 | 655 | 'EE_Messages_Queue' => 'load_lib', |
| 656 | 656 | 'EE_Messages_Data_Handler_Collection' => 'load_lib', |
| 657 | 657 | 'EE_Message_Template_Group_Collection' => 'load_lib', |
| 658 | - 'EE_Messages_Generator' => function () { |
|
| 658 | + 'EE_Messages_Generator' => function() { |
|
| 659 | 659 | return EE_Registry::instance()->load_lib( |
| 660 | 660 | 'Messages_Generator', |
| 661 | 661 | array(), |
@@ -663,7 +663,7 @@ discard block |
||
| 663 | 663 | false |
| 664 | 664 | ); |
| 665 | 665 | }, |
| 666 | - 'EE_Messages_Template_Defaults' => function ($arguments = array()) { |
|
| 666 | + 'EE_Messages_Template_Defaults' => function($arguments = array()) { |
|
| 667 | 667 | return EE_Registry::instance()->load_lib( |
| 668 | 668 | 'Messages_Template_Defaults', |
| 669 | 669 | $arguments, |
@@ -676,19 +676,19 @@ discard block |
||
| 676 | 676 | 'EEM_Message_Template_Group' => 'load_model', |
| 677 | 677 | 'EEM_Message_Template' => 'load_model', |
| 678 | 678 | //load_helper |
| 679 | - 'EEH_Parse_Shortcodes' => function () { |
|
| 679 | + 'EEH_Parse_Shortcodes' => function() { |
|
| 680 | 680 | if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) { |
| 681 | 681 | return new EEH_Parse_Shortcodes(); |
| 682 | 682 | } |
| 683 | 683 | return null; |
| 684 | 684 | }, |
| 685 | - 'EE_Template_Config' => function () { |
|
| 685 | + 'EE_Template_Config' => function() { |
|
| 686 | 686 | return EE_Config::instance()->template_settings; |
| 687 | 687 | }, |
| 688 | - 'EE_Currency_Config' => function () { |
|
| 688 | + 'EE_Currency_Config' => function() { |
|
| 689 | 689 | return EE_Config::instance()->currency; |
| 690 | 690 | }, |
| 691 | - 'EventEspresso\core\services\loaders\Loader' => function () use (&$loader) { |
|
| 691 | + 'EventEspresso\core\services\loaders\Loader' => function() use (&$loader) { |
|
| 692 | 692 | return $loader; |
| 693 | 693 | }, |
| 694 | 694 | ); |
@@ -1,5 +1,5 @@ discard block |
||
| 1 | 1 | <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
| 2 | - exit('No direct script access allowed'); |
|
| 2 | + exit('No direct script access allowed'); |
|
| 3 | 3 | } |
| 4 | 4 | |
| 5 | 5 | /** |
@@ -24,470 +24,470 @@ discard block |
||
| 24 | 24 | { |
| 25 | 25 | |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * This gets set in _setup_cpt |
|
| 29 | - * It will contain the object for the custom post type. |
|
| 30 | - * |
|
| 31 | - * @var EE_CPT_Base |
|
| 32 | - */ |
|
| 33 | - protected $_cpt_object; |
|
| 34 | - |
|
| 35 | - |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * a boolean flag to set whether the current route is a cpt route or not. |
|
| 39 | - * |
|
| 40 | - * @var bool |
|
| 41 | - */ |
|
| 42 | - protected $_cpt_route = false; |
|
| 43 | - |
|
| 44 | - |
|
| 45 | - |
|
| 46 | - /** |
|
| 47 | - * This property allows cpt classes to define multiple routes as cpt routes. |
|
| 48 | - * //in this array we define what the custom post type for this route is. |
|
| 49 | - * array( |
|
| 50 | - * 'route_name' => 'custom_post_type_slug' |
|
| 51 | - * ) |
|
| 52 | - * |
|
| 53 | - * @var array |
|
| 54 | - */ |
|
| 55 | - protected $_cpt_routes = array(); |
|
| 56 | - |
|
| 27 | + /** |
|
| 28 | + * This gets set in _setup_cpt |
|
| 29 | + * It will contain the object for the custom post type. |
|
| 30 | + * |
|
| 31 | + * @var EE_CPT_Base |
|
| 32 | + */ |
|
| 33 | + protected $_cpt_object; |
|
| 34 | + |
|
| 35 | + |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * a boolean flag to set whether the current route is a cpt route or not. |
|
| 39 | + * |
|
| 40 | + * @var bool |
|
| 41 | + */ |
|
| 42 | + protected $_cpt_route = false; |
|
| 43 | + |
|
| 44 | + |
|
| 45 | + |
|
| 46 | + /** |
|
| 47 | + * This property allows cpt classes to define multiple routes as cpt routes. |
|
| 48 | + * //in this array we define what the custom post type for this route is. |
|
| 49 | + * array( |
|
| 50 | + * 'route_name' => 'custom_post_type_slug' |
|
| 51 | + * ) |
|
| 52 | + * |
|
| 53 | + * @var array |
|
| 54 | + */ |
|
| 55 | + protected $_cpt_routes = array(); |
|
| 56 | + |
|
| 57 | 57 | |
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * This simply defines what the corresponding routes WP will be redirected to after completing a post save/update. |
|
| 61 | - * in this format: |
|
| 62 | - * array( |
|
| 63 | - * 'post_type_slug' => 'edit_route' |
|
| 64 | - * ) |
|
| 65 | - * |
|
| 66 | - * @var array |
|
| 67 | - */ |
|
| 68 | - protected $_cpt_edit_routes = array(); |
|
| 69 | - |
|
| 70 | - |
|
| 71 | - |
|
| 72 | - /** |
|
| 73 | - * If child classes set the name of their main model via the $_cpt_obj_models property, EE_Admin_Page_CPT will |
|
| 74 | - * attempt to retrieve the related object model for the edit pages and assign it to _cpt_page_object. the |
|
| 75 | - * _cpt_model_names property should be in the following format: array( |
|
| 76 | - * 'route_defined_by_action_param' => 'Model_Name') |
|
| 77 | - * |
|
| 78 | - * @var array $_cpt_model_names |
|
| 79 | - */ |
|
| 80 | - protected $_cpt_model_names = array(); |
|
| 81 | - |
|
| 82 | - |
|
| 83 | - /** |
|
| 84 | - * @var EE_CPT_Base |
|
| 85 | - */ |
|
| 86 | - protected $_cpt_model_obj = false; |
|
| 87 | - |
|
| 88 | - |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * This will hold an array of autosave containers that will be used to obtain input values and hook into the WP |
|
| 92 | - * autosave so we can save our inputs on the save_post hook! Children classes should add to this array by using |
|
| 93 | - * the _register_autosave_containers() method so that we don't override any other containers already registered. |
|
| 94 | - * Registration of containers should be done before load_page_dependencies() is run. |
|
| 95 | - * |
|
| 96 | - * @var array() |
|
| 97 | - */ |
|
| 98 | - protected $_autosave_containers = array(); |
|
| 99 | - protected $_autosave_fields = array(); |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * Array mapping from admin actions to their equivalent wp core pages for custom post types. So when a user visits |
|
| 103 | - * a page for an action, it will appear as if they were visiting the wp core page for that custom post type |
|
| 104 | - * |
|
| 105 | - * @var array |
|
| 106 | - */ |
|
| 107 | - protected $_pagenow_map; |
|
| 108 | - |
|
| 109 | - |
|
| 110 | - |
|
| 111 | - /** |
|
| 112 | - * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been |
|
| 113 | - * saved. Child classes are required to declare this method. Typically you would use this to save any additional |
|
| 114 | - * data. Keep in mind also that "save_post" runs on EVERY post update to the database. ALSO very important. When a |
|
| 115 | - * post transitions from scheduled to published, the save_post action is fired but you will NOT have any _POST data |
|
| 116 | - * containing any extra info you may have from other meta saves. So MAKE sure that you handle this accordingly. |
|
| 117 | - * |
|
| 118 | - * @access protected |
|
| 119 | - * @abstract |
|
| 120 | - * @param string $post_id The ID of the cpt that was saved (so you can link relationally) |
|
| 121 | - * @param EE_CPT_Base $post The post object of the cpt that was saved. |
|
| 122 | - * @return void |
|
| 123 | - */ |
|
| 124 | - abstract protected function _insert_update_cpt_item($post_id, $post); |
|
| 125 | - |
|
| 126 | - |
|
| 127 | - |
|
| 128 | - /** |
|
| 129 | - * This is hooked into the WordPress do_action('trashed_post') hook and runs after a cpt has been trashed. |
|
| 130 | - * |
|
| 131 | - * @abstract |
|
| 132 | - * @access public |
|
| 133 | - * @param string $post_id The ID of the cpt that was trashed |
|
| 134 | - * @return void |
|
| 135 | - */ |
|
| 136 | - abstract public function trash_cpt_item($post_id); |
|
| 137 | - |
|
| 138 | - |
|
| 139 | - |
|
| 140 | - /** |
|
| 141 | - * This is hooked into the WordPress do_action('untrashed_post') hook and runs after a cpt has been untrashed |
|
| 142 | - * |
|
| 143 | - * @param string $post_id theID of the cpt that was untrashed |
|
| 144 | - * @return void |
|
| 145 | - */ |
|
| 146 | - abstract public function restore_cpt_item($post_id); |
|
| 147 | - |
|
| 148 | - |
|
| 149 | - |
|
| 150 | - /** |
|
| 151 | - * This is hooked into the WordPress do_action('delete_cpt_item') hook and runs after a cpt has been fully deleted |
|
| 152 | - * from the db |
|
| 153 | - * |
|
| 154 | - * @param string $post_id the ID of the cpt that was deleted |
|
| 155 | - * @return void |
|
| 156 | - */ |
|
| 157 | - abstract public function delete_cpt_item($post_id); |
|
| 158 | - |
|
| 159 | - |
|
| 160 | - |
|
| 161 | - /** |
|
| 162 | - * Just utilizing the method EE_Admin exposes for doing things before page setup. |
|
| 163 | - * |
|
| 164 | - * @access protected |
|
| 165 | - * @return void |
|
| 166 | - */ |
|
| 167 | - protected function _before_page_setup() |
|
| 168 | - { |
|
| 169 | - $page = isset($this->_req_data['page']) ? $this->_req_data['page'] : $this->page_slug; |
|
| 170 | - $this->_cpt_routes = array_merge(array( |
|
| 171 | - 'create_new' => $this->page_slug, |
|
| 172 | - 'edit' => $this->page_slug, |
|
| 173 | - 'trash' => $this->page_slug, |
|
| 174 | - ), $this->_cpt_routes); |
|
| 175 | - //let's see if the current route has a value for cpt_object_slug if it does we use that instead of the page |
|
| 176 | - $this->_cpt_object = isset($this->_req_data['action']) && isset($this->_cpt_routes[$this->_req_data['action']]) |
|
| 177 | - ? get_post_type_object($this->_cpt_routes[$this->_req_data['action']]) |
|
| 178 | - : get_post_type_object($page); |
|
| 179 | - //tweak pagenow for page loading. |
|
| 180 | - if ( ! $this->_pagenow_map) { |
|
| 181 | - $this->_pagenow_map = array( |
|
| 182 | - 'create_new' => 'post-new.php', |
|
| 183 | - 'edit' => 'post.php', |
|
| 184 | - 'trash' => 'post.php', |
|
| 185 | - ); |
|
| 186 | - } |
|
| 187 | - add_action('current_screen', array($this, 'modify_pagenow')); |
|
| 188 | - //TODO the below will need to be reworked to account for the cpt routes that are NOT based off of page but action param. |
|
| 189 | - //get current page from autosave |
|
| 190 | - $current_page = isset($this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page']) |
|
| 191 | - ? $this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page'] |
|
| 192 | - : null; |
|
| 193 | - $this->_current_page = isset($this->_req_data['current_page']) |
|
| 194 | - ? $this->_req_data['current_page'] |
|
| 195 | - : $current_page; |
|
| 196 | - //autosave... make sure its only for the correct page |
|
| 197 | - //if ( ! empty($this->_current_page) && $this->_current_page == $this->page_slug) { |
|
| 198 | - //setup autosave ajax hook |
|
| 199 | - //add_action('wp_ajax_ee-autosave', array( $this, 'do_extra_autosave_stuff' ), 10 ); //TODO reactivate when 4.2 autosave is implemented |
|
| 200 | - //} |
|
| 201 | - } |
|
| 202 | - |
|
| 203 | - |
|
| 204 | - |
|
| 205 | - /** |
|
| 206 | - * Simply ensure that we simulate the correct post route for cpt screens |
|
| 207 | - * |
|
| 208 | - * @param WP_Screen $current_screen |
|
| 209 | - * @return void |
|
| 210 | - */ |
|
| 211 | - public function modify_pagenow($current_screen) |
|
| 212 | - { |
|
| 213 | - global $pagenow, $hook_suffix; |
|
| 214 | - //possibly reset pagenow. |
|
| 215 | - if ( ! empty($this->_req_data['page']) |
|
| 216 | - && $this->_req_data['page'] == $this->page_slug |
|
| 217 | - && ! empty($this->_req_data['action']) |
|
| 218 | - && isset($this->_pagenow_map[$this->_req_data['action']]) |
|
| 219 | - ) { |
|
| 220 | - $pagenow = $this->_pagenow_map[$this->_req_data['action']]; |
|
| 221 | - $hook_suffix = $pagenow; |
|
| 222 | - } |
|
| 223 | - } |
|
| 224 | - |
|
| 225 | - |
|
| 226 | - |
|
| 227 | - /** |
|
| 228 | - * This method is used to register additional autosave containers to the _autosave_containers property. |
|
| 229 | - * |
|
| 230 | - * @todo We should automate this at some point by creating a wrapper for add_post_metabox and in our wrapper we |
|
| 231 | - * automatically register the id for the post metabox as a container. |
|
| 232 | - * @param array $ids an array of ids for containers that hold form inputs we want autosave to pickup. Typically |
|
| 233 | - * you would send along the id of a metabox container. |
|
| 234 | - * @return void |
|
| 235 | - */ |
|
| 236 | - protected function _register_autosave_containers($ids) |
|
| 237 | - { |
|
| 238 | - $this->_autosave_containers = array_merge($this->_autosave_fields, (array)$ids); |
|
| 239 | - } |
|
| 240 | - |
|
| 241 | - |
|
| 242 | - |
|
| 243 | - /** |
|
| 244 | - * Something nifty. We're going to loop through all the registered metaboxes and if the CALLBACK is an instance of |
|
| 245 | - * EE_Admin_Page OR EE_Admin_Hooks, then we'll add the id to our _autosave_containers array. |
|
| 246 | - */ |
|
| 247 | - protected function _set_autosave_containers() |
|
| 248 | - { |
|
| 249 | - global $wp_meta_boxes; |
|
| 250 | - $containers = array(); |
|
| 251 | - if (empty($wp_meta_boxes)) { |
|
| 252 | - return; |
|
| 253 | - } |
|
| 254 | - $current_metaboxes = isset($wp_meta_boxes[$this->page_slug]) ? $wp_meta_boxes[$this->page_slug] : array(); |
|
| 255 | - foreach ($current_metaboxes as $box_context) { |
|
| 256 | - foreach ($box_context as $box_details) { |
|
| 257 | - foreach ($box_details as $box) { |
|
| 258 | - if ( |
|
| 259 | - is_array($box['callback']) |
|
| 260 | - && ( |
|
| 261 | - $box['callback'][0] instanceof EE_Admin_Page |
|
| 262 | - || $box['callback'][0] instanceof EE_Admin_Hooks |
|
| 263 | - ) |
|
| 264 | - ) { |
|
| 265 | - $containers[] = $box['id']; |
|
| 266 | - } |
|
| 267 | - } |
|
| 268 | - } |
|
| 269 | - } |
|
| 270 | - $this->_autosave_containers = array_merge($this->_autosave_containers, $containers); |
|
| 271 | - //add hidden inputs container |
|
| 272 | - $this->_autosave_containers[] = 'ee-cpt-hidden-inputs'; |
|
| 273 | - } |
|
| 274 | - |
|
| 275 | - |
|
| 276 | - |
|
| 277 | - protected function _load_autosave_scripts_styles() |
|
| 278 | - { |
|
| 279 | - /*wp_register_script('cpt-autosave', EE_ADMIN_URL . 'assets/ee-cpt-autosave.js', array('ee-serialize-full-array', 'event_editor_js'), EVENT_ESPRESSO_VERSION, TRUE ); |
|
| 59 | + /** |
|
| 60 | + * This simply defines what the corresponding routes WP will be redirected to after completing a post save/update. |
|
| 61 | + * in this format: |
|
| 62 | + * array( |
|
| 63 | + * 'post_type_slug' => 'edit_route' |
|
| 64 | + * ) |
|
| 65 | + * |
|
| 66 | + * @var array |
|
| 67 | + */ |
|
| 68 | + protected $_cpt_edit_routes = array(); |
|
| 69 | + |
|
| 70 | + |
|
| 71 | + |
|
| 72 | + /** |
|
| 73 | + * If child classes set the name of their main model via the $_cpt_obj_models property, EE_Admin_Page_CPT will |
|
| 74 | + * attempt to retrieve the related object model for the edit pages and assign it to _cpt_page_object. the |
|
| 75 | + * _cpt_model_names property should be in the following format: array( |
|
| 76 | + * 'route_defined_by_action_param' => 'Model_Name') |
|
| 77 | + * |
|
| 78 | + * @var array $_cpt_model_names |
|
| 79 | + */ |
|
| 80 | + protected $_cpt_model_names = array(); |
|
| 81 | + |
|
| 82 | + |
|
| 83 | + /** |
|
| 84 | + * @var EE_CPT_Base |
|
| 85 | + */ |
|
| 86 | + protected $_cpt_model_obj = false; |
|
| 87 | + |
|
| 88 | + |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * This will hold an array of autosave containers that will be used to obtain input values and hook into the WP |
|
| 92 | + * autosave so we can save our inputs on the save_post hook! Children classes should add to this array by using |
|
| 93 | + * the _register_autosave_containers() method so that we don't override any other containers already registered. |
|
| 94 | + * Registration of containers should be done before load_page_dependencies() is run. |
|
| 95 | + * |
|
| 96 | + * @var array() |
|
| 97 | + */ |
|
| 98 | + protected $_autosave_containers = array(); |
|
| 99 | + protected $_autosave_fields = array(); |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * Array mapping from admin actions to their equivalent wp core pages for custom post types. So when a user visits |
|
| 103 | + * a page for an action, it will appear as if they were visiting the wp core page for that custom post type |
|
| 104 | + * |
|
| 105 | + * @var array |
|
| 106 | + */ |
|
| 107 | + protected $_pagenow_map; |
|
| 108 | + |
|
| 109 | + |
|
| 110 | + |
|
| 111 | + /** |
|
| 112 | + * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been |
|
| 113 | + * saved. Child classes are required to declare this method. Typically you would use this to save any additional |
|
| 114 | + * data. Keep in mind also that "save_post" runs on EVERY post update to the database. ALSO very important. When a |
|
| 115 | + * post transitions from scheduled to published, the save_post action is fired but you will NOT have any _POST data |
|
| 116 | + * containing any extra info you may have from other meta saves. So MAKE sure that you handle this accordingly. |
|
| 117 | + * |
|
| 118 | + * @access protected |
|
| 119 | + * @abstract |
|
| 120 | + * @param string $post_id The ID of the cpt that was saved (so you can link relationally) |
|
| 121 | + * @param EE_CPT_Base $post The post object of the cpt that was saved. |
|
| 122 | + * @return void |
|
| 123 | + */ |
|
| 124 | + abstract protected function _insert_update_cpt_item($post_id, $post); |
|
| 125 | + |
|
| 126 | + |
|
| 127 | + |
|
| 128 | + /** |
|
| 129 | + * This is hooked into the WordPress do_action('trashed_post') hook and runs after a cpt has been trashed. |
|
| 130 | + * |
|
| 131 | + * @abstract |
|
| 132 | + * @access public |
|
| 133 | + * @param string $post_id The ID of the cpt that was trashed |
|
| 134 | + * @return void |
|
| 135 | + */ |
|
| 136 | + abstract public function trash_cpt_item($post_id); |
|
| 137 | + |
|
| 138 | + |
|
| 139 | + |
|
| 140 | + /** |
|
| 141 | + * This is hooked into the WordPress do_action('untrashed_post') hook and runs after a cpt has been untrashed |
|
| 142 | + * |
|
| 143 | + * @param string $post_id theID of the cpt that was untrashed |
|
| 144 | + * @return void |
|
| 145 | + */ |
|
| 146 | + abstract public function restore_cpt_item($post_id); |
|
| 147 | + |
|
| 148 | + |
|
| 149 | + |
|
| 150 | + /** |
|
| 151 | + * This is hooked into the WordPress do_action('delete_cpt_item') hook and runs after a cpt has been fully deleted |
|
| 152 | + * from the db |
|
| 153 | + * |
|
| 154 | + * @param string $post_id the ID of the cpt that was deleted |
|
| 155 | + * @return void |
|
| 156 | + */ |
|
| 157 | + abstract public function delete_cpt_item($post_id); |
|
| 158 | + |
|
| 159 | + |
|
| 160 | + |
|
| 161 | + /** |
|
| 162 | + * Just utilizing the method EE_Admin exposes for doing things before page setup. |
|
| 163 | + * |
|
| 164 | + * @access protected |
|
| 165 | + * @return void |
|
| 166 | + */ |
|
| 167 | + protected function _before_page_setup() |
|
| 168 | + { |
|
| 169 | + $page = isset($this->_req_data['page']) ? $this->_req_data['page'] : $this->page_slug; |
|
| 170 | + $this->_cpt_routes = array_merge(array( |
|
| 171 | + 'create_new' => $this->page_slug, |
|
| 172 | + 'edit' => $this->page_slug, |
|
| 173 | + 'trash' => $this->page_slug, |
|
| 174 | + ), $this->_cpt_routes); |
|
| 175 | + //let's see if the current route has a value for cpt_object_slug if it does we use that instead of the page |
|
| 176 | + $this->_cpt_object = isset($this->_req_data['action']) && isset($this->_cpt_routes[$this->_req_data['action']]) |
|
| 177 | + ? get_post_type_object($this->_cpt_routes[$this->_req_data['action']]) |
|
| 178 | + : get_post_type_object($page); |
|
| 179 | + //tweak pagenow for page loading. |
|
| 180 | + if ( ! $this->_pagenow_map) { |
|
| 181 | + $this->_pagenow_map = array( |
|
| 182 | + 'create_new' => 'post-new.php', |
|
| 183 | + 'edit' => 'post.php', |
|
| 184 | + 'trash' => 'post.php', |
|
| 185 | + ); |
|
| 186 | + } |
|
| 187 | + add_action('current_screen', array($this, 'modify_pagenow')); |
|
| 188 | + //TODO the below will need to be reworked to account for the cpt routes that are NOT based off of page but action param. |
|
| 189 | + //get current page from autosave |
|
| 190 | + $current_page = isset($this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page']) |
|
| 191 | + ? $this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page'] |
|
| 192 | + : null; |
|
| 193 | + $this->_current_page = isset($this->_req_data['current_page']) |
|
| 194 | + ? $this->_req_data['current_page'] |
|
| 195 | + : $current_page; |
|
| 196 | + //autosave... make sure its only for the correct page |
|
| 197 | + //if ( ! empty($this->_current_page) && $this->_current_page == $this->page_slug) { |
|
| 198 | + //setup autosave ajax hook |
|
| 199 | + //add_action('wp_ajax_ee-autosave', array( $this, 'do_extra_autosave_stuff' ), 10 ); //TODO reactivate when 4.2 autosave is implemented |
|
| 200 | + //} |
|
| 201 | + } |
|
| 202 | + |
|
| 203 | + |
|
| 204 | + |
|
| 205 | + /** |
|
| 206 | + * Simply ensure that we simulate the correct post route for cpt screens |
|
| 207 | + * |
|
| 208 | + * @param WP_Screen $current_screen |
|
| 209 | + * @return void |
|
| 210 | + */ |
|
| 211 | + public function modify_pagenow($current_screen) |
|
| 212 | + { |
|
| 213 | + global $pagenow, $hook_suffix; |
|
| 214 | + //possibly reset pagenow. |
|
| 215 | + if ( ! empty($this->_req_data['page']) |
|
| 216 | + && $this->_req_data['page'] == $this->page_slug |
|
| 217 | + && ! empty($this->_req_data['action']) |
|
| 218 | + && isset($this->_pagenow_map[$this->_req_data['action']]) |
|
| 219 | + ) { |
|
| 220 | + $pagenow = $this->_pagenow_map[$this->_req_data['action']]; |
|
| 221 | + $hook_suffix = $pagenow; |
|
| 222 | + } |
|
| 223 | + } |
|
| 224 | + |
|
| 225 | + |
|
| 226 | + |
|
| 227 | + /** |
|
| 228 | + * This method is used to register additional autosave containers to the _autosave_containers property. |
|
| 229 | + * |
|
| 230 | + * @todo We should automate this at some point by creating a wrapper for add_post_metabox and in our wrapper we |
|
| 231 | + * automatically register the id for the post metabox as a container. |
|
| 232 | + * @param array $ids an array of ids for containers that hold form inputs we want autosave to pickup. Typically |
|
| 233 | + * you would send along the id of a metabox container. |
|
| 234 | + * @return void |
|
| 235 | + */ |
|
| 236 | + protected function _register_autosave_containers($ids) |
|
| 237 | + { |
|
| 238 | + $this->_autosave_containers = array_merge($this->_autosave_fields, (array)$ids); |
|
| 239 | + } |
|
| 240 | + |
|
| 241 | + |
|
| 242 | + |
|
| 243 | + /** |
|
| 244 | + * Something nifty. We're going to loop through all the registered metaboxes and if the CALLBACK is an instance of |
|
| 245 | + * EE_Admin_Page OR EE_Admin_Hooks, then we'll add the id to our _autosave_containers array. |
|
| 246 | + */ |
|
| 247 | + protected function _set_autosave_containers() |
|
| 248 | + { |
|
| 249 | + global $wp_meta_boxes; |
|
| 250 | + $containers = array(); |
|
| 251 | + if (empty($wp_meta_boxes)) { |
|
| 252 | + return; |
|
| 253 | + } |
|
| 254 | + $current_metaboxes = isset($wp_meta_boxes[$this->page_slug]) ? $wp_meta_boxes[$this->page_slug] : array(); |
|
| 255 | + foreach ($current_metaboxes as $box_context) { |
|
| 256 | + foreach ($box_context as $box_details) { |
|
| 257 | + foreach ($box_details as $box) { |
|
| 258 | + if ( |
|
| 259 | + is_array($box['callback']) |
|
| 260 | + && ( |
|
| 261 | + $box['callback'][0] instanceof EE_Admin_Page |
|
| 262 | + || $box['callback'][0] instanceof EE_Admin_Hooks |
|
| 263 | + ) |
|
| 264 | + ) { |
|
| 265 | + $containers[] = $box['id']; |
|
| 266 | + } |
|
| 267 | + } |
|
| 268 | + } |
|
| 269 | + } |
|
| 270 | + $this->_autosave_containers = array_merge($this->_autosave_containers, $containers); |
|
| 271 | + //add hidden inputs container |
|
| 272 | + $this->_autosave_containers[] = 'ee-cpt-hidden-inputs'; |
|
| 273 | + } |
|
| 274 | + |
|
| 275 | + |
|
| 276 | + |
|
| 277 | + protected function _load_autosave_scripts_styles() |
|
| 278 | + { |
|
| 279 | + /*wp_register_script('cpt-autosave', EE_ADMIN_URL . 'assets/ee-cpt-autosave.js', array('ee-serialize-full-array', 'event_editor_js'), EVENT_ESPRESSO_VERSION, TRUE ); |
|
| 280 | 280 | wp_enqueue_script('cpt-autosave');/**/ //todo re-enable when we start doing autosave again in 4.2 |
| 281 | 281 | |
| 282 | - //filter _autosave_containers |
|
| 283 | - $containers = apply_filters('FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers', |
|
| 284 | - $this->_autosave_containers, $this); |
|
| 285 | - $containers = apply_filters('FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers', |
|
| 286 | - $containers, $this); |
|
| 287 | - |
|
| 288 | - wp_localize_script('event_editor_js', 'EE_AUTOSAVE_IDS', |
|
| 289 | - $containers); //todo once we enable autosaves, this needs to be switched to localize with "cpt-autosave" |
|
| 290 | - |
|
| 291 | - $unsaved_data_msg = array( |
|
| 292 | - 'eventmsg' => sprintf(__("The changes you made to this %s will be lost if you navigate away from this page.", |
|
| 293 | - 'event_espresso'), $this->_cpt_object->labels->singular_name), |
|
| 294 | - 'inputChanged' => 0, |
|
| 295 | - ); |
|
| 296 | - wp_localize_script('event_editor_js', 'UNSAVED_DATA_MSG', $unsaved_data_msg); |
|
| 297 | - } |
|
| 298 | - |
|
| 299 | - |
|
| 300 | - |
|
| 301 | - public function load_page_dependencies() |
|
| 302 | - { |
|
| 303 | - try { |
|
| 304 | - $this->_load_page_dependencies(); |
|
| 305 | - } catch (EE_Error $e) { |
|
| 306 | - $e->get_error(); |
|
| 307 | - } |
|
| 308 | - } |
|
| 309 | - |
|
| 310 | - |
|
| 311 | - |
|
| 312 | - /** |
|
| 313 | - * overloading the EE_Admin_Page parent load_page_dependencies so we can get the cpt stuff added in appropriately |
|
| 314 | - * |
|
| 315 | - * @access protected |
|
| 316 | - * @return void |
|
| 317 | - */ |
|
| 318 | - protected function _load_page_dependencies() |
|
| 319 | - { |
|
| 320 | - //we only add stuff if this is a cpt_route! |
|
| 321 | - if ( ! $this->_cpt_route) { |
|
| 322 | - parent::_load_page_dependencies(); |
|
| 323 | - return; |
|
| 324 | - } |
|
| 325 | - // now let's do some automatic filters into the wp_system |
|
| 326 | - // and we'll check to make sure the CHILD class |
|
| 327 | - // automatically has the required methods in place. |
|
| 328 | - // the following filters are for setting all the redirects |
|
| 329 | - // on DEFAULT WP custom post type actions |
|
| 330 | - // let's add a hidden input to the post-edit form |
|
| 331 | - // so we know when we have to trigger our custom redirects! |
|
| 332 | - // Otherwise the redirects will happen on ALL post saves which wouldn't be good of course! |
|
| 333 | - add_action('edit_form_after_title', array($this, 'cpt_post_form_hidden_input')); |
|
| 334 | - // inject our Admin page nav tabs... |
|
| 335 | - // let's make sure the nav tabs are set if they aren't already |
|
| 336 | - // if ( empty( $this->_nav_tabs ) ) $this->_set_nav_tabs(); |
|
| 337 | - add_action('post_edit_form_tag', array($this, 'inject_nav_tabs')); |
|
| 338 | - // modify the post_updated messages array |
|
| 339 | - add_action('post_updated_messages', array($this, 'post_update_messages'), 10); |
|
| 340 | - // add shortlink button to cpt edit screens. We can do this as a universal thing BECAUSE, |
|
| 341 | - // cpts use the same format for shortlinks as posts! |
|
| 342 | - add_filter('pre_get_shortlink', array($this, 'add_shortlink_button_to_editor'), 10, 4); |
|
| 343 | - // This basically allows us to change the title of the "publish" metabox area |
|
| 344 | - // on CPT pages by setting a 'publishbox' value in the $_labels property array in the child class. |
|
| 345 | - if ( ! empty($this->_labels['publishbox'])) { |
|
| 346 | - $box_label = is_array($this->_labels['publishbox']) |
|
| 347 | - && isset($this->_labels['publishbox'][$this->_req_action]) |
|
| 348 | - ? $this->_labels['publishbox'][$this->_req_action] |
|
| 349 | - : $this->_labels['publishbox']; |
|
| 350 | - add_meta_box( |
|
| 351 | - 'submitdiv', |
|
| 352 | - $box_label, |
|
| 353 | - 'post_submit_meta_box', |
|
| 354 | - $this->_cpt_routes[$this->_req_action], |
|
| 355 | - 'side', |
|
| 356 | - 'core' |
|
| 357 | - ); |
|
| 358 | - } |
|
| 359 | - //let's add page_templates metabox if this cpt added support for it. |
|
| 360 | - if ($this->_supports_page_templates($this->_cpt_object->name)) { |
|
| 361 | - add_meta_box( |
|
| 362 | - 'page_templates', |
|
| 363 | - __('Page Template', 'event_espresso'), |
|
| 364 | - array($this, 'page_template_meta_box'), |
|
| 365 | - $this->_cpt_routes[$this->_req_action], |
|
| 366 | - 'side', |
|
| 367 | - 'default' |
|
| 368 | - ); |
|
| 369 | - } |
|
| 370 | - //this is a filter that allows the addition of extra html after the permalink field on the wp post edit-form |
|
| 371 | - if (method_exists($this, 'extra_permalink_field_buttons')) { |
|
| 372 | - add_filter('get_sample_permalink_html', array($this, 'extra_permalink_field_buttons'), 10, 4); |
|
| 373 | - } |
|
| 374 | - //add preview button |
|
| 375 | - add_filter('get_sample_permalink_html', array($this, 'preview_button_html'), 5, 4); |
|
| 376 | - //insert our own post_stati dropdown |
|
| 377 | - add_action('post_submitbox_misc_actions', array($this, 'custom_post_stati_dropdown'), 10); |
|
| 378 | - //This allows adding additional information to the publish post submitbox on the wp post edit form |
|
| 379 | - if (method_exists($this, 'extra_misc_actions_publish_box')) { |
|
| 380 | - add_action('post_submitbox_misc_actions', array($this, 'extra_misc_actions_publish_box'), 10); |
|
| 381 | - } |
|
| 382 | - // This allows for adding additional stuff after the title field on the wp post edit form. |
|
| 383 | - // This is also before the wp_editor for post description field. |
|
| 384 | - if (method_exists($this, 'edit_form_after_title')) { |
|
| 385 | - add_action('edit_form_after_title', array($this, 'edit_form_after_title'), 10); |
|
| 386 | - } |
|
| 387 | - /** |
|
| 388 | - * Filtering WP's esc_url to capture urls pointing to core wp routes so they point to our route. |
|
| 389 | - */ |
|
| 390 | - add_filter('clean_url', array($this, 'switch_core_wp_urls_with_ours'), 10, 3); |
|
| 391 | - parent::_load_page_dependencies(); |
|
| 392 | - // notice we are ALSO going to load the pagenow hook set for this route |
|
| 393 | - // (see _before_page_setup for the reset of the pagenow global ). |
|
| 394 | - // This is for any plugins that are doing things properly |
|
| 395 | - // and hooking into the load page hook for core wp cpt routes. |
|
| 396 | - global $pagenow; |
|
| 397 | - do_action('load-' . $pagenow); |
|
| 398 | - $this->modify_current_screen(); |
|
| 399 | - add_action('admin_enqueue_scripts', array($this, 'setup_autosave_hooks'), 30); |
|
| 400 | - //we route REALLY early. |
|
| 401 | - try { |
|
| 402 | - $this->_route_admin_request(); |
|
| 403 | - } catch (EE_Error $e) { |
|
| 404 | - $e->get_error(); |
|
| 405 | - } |
|
| 406 | - } |
|
| 407 | - |
|
| 408 | - |
|
| 409 | - |
|
| 410 | - /** |
|
| 411 | - * Since we don't want users going to default core wp routes, this will check any wp urls run through the |
|
| 412 | - * esc_url() method and if we see a url matching a pattern for our routes, we'll modify it to point to OUR |
|
| 413 | - * route instead. |
|
| 414 | - * |
|
| 415 | - * @param string $good_protocol_url The escaped url. |
|
| 416 | - * @param string $original_url The original url. |
|
| 417 | - * @param string $_context The context sent to the esc_url method. |
|
| 418 | - * @return string possibly a new url for our route. |
|
| 419 | - */ |
|
| 420 | - public function switch_core_wp_urls_with_ours($good_protocol_url, $original_url, $_context) |
|
| 421 | - { |
|
| 422 | - $routes_to_match = array( |
|
| 423 | - 0 => array( |
|
| 424 | - 'edit.php?post_type=espresso_attendees', |
|
| 425 | - 'admin.php?page=espresso_registrations&action=contact_list', |
|
| 426 | - ), |
|
| 427 | - 1 => array( |
|
| 428 | - 'edit.php?post_type=' . $this->_cpt_object->name, |
|
| 429 | - 'admin.php?page=' . $this->_cpt_object->name, |
|
| 430 | - ), |
|
| 431 | - ); |
|
| 432 | - foreach ($routes_to_match as $route_matches) { |
|
| 433 | - if (strpos($good_protocol_url, $route_matches[0]) !== false) { |
|
| 434 | - return str_replace($route_matches[0], $route_matches[1], $good_protocol_url); |
|
| 435 | - } |
|
| 436 | - } |
|
| 437 | - return $good_protocol_url; |
|
| 438 | - } |
|
| 439 | - |
|
| 440 | - |
|
| 441 | - |
|
| 442 | - /** |
|
| 443 | - * Determine whether the current cpt supports page templates or not. |
|
| 444 | - * |
|
| 445 | - * @since %VER% |
|
| 446 | - * @param string $cpt_name The cpt slug we're checking on. |
|
| 447 | - * @return bool True supported, false not. |
|
| 448 | - */ |
|
| 449 | - private function _supports_page_templates($cpt_name) |
|
| 450 | - { |
|
| 451 | - |
|
| 452 | - $cpt_args = EE_Register_CPTs::get_CPTs(); |
|
| 453 | - $cpt_args = isset($cpt_args[$cpt_name]) ? $cpt_args[$cpt_name]['args'] : array(); |
|
| 454 | - $cpt_has_support = ! empty($cpt_args['page_templates']); |
|
| 455 | - |
|
| 456 | - //if the installed version of WP is > 4.7 we do some additional checks. |
|
| 457 | - if (EE_Recommended_Versions::check_wp_version('4.7','>=')) { |
|
| 458 | - $post_templates = wp_get_theme()->get_post_templates(); |
|
| 459 | - //if there are $post_templates for this cpt, then we return false for this method because |
|
| 460 | - //that means we aren't going to load our page template manager and leave that up to the native |
|
| 461 | - //cpt template manager. |
|
| 462 | - $cpt_has_support = ! isset($post_templates[$cpt_name]) ? $cpt_has_support : false; |
|
| 463 | - } |
|
| 464 | - |
|
| 465 | - return $cpt_has_support; |
|
| 466 | - } |
|
| 467 | - |
|
| 468 | - |
|
| 469 | - /** |
|
| 470 | - * Callback for the page_templates metabox selector. |
|
| 471 | - * |
|
| 472 | - * @since %VER% |
|
| 473 | - * @return void |
|
| 474 | - */ |
|
| 475 | - public function page_template_meta_box() |
|
| 476 | - { |
|
| 477 | - global $post; |
|
| 478 | - $template = ''; |
|
| 479 | - |
|
| 480 | - if (EE_Recommended_Versions::check_wp_version('4.7','>=')) { |
|
| 481 | - $page_template_count = count(get_page_templates()); |
|
| 482 | - } else { |
|
| 483 | - $page_template_count = count(get_page_templates($post)); |
|
| 484 | - }; |
|
| 485 | - |
|
| 486 | - if ($page_template_count) { |
|
| 487 | - $page_template = get_post_meta($post->ID, '_wp_page_template', true); |
|
| 488 | - $template = ! empty($page_template) ? $page_template : ''; |
|
| 489 | - } |
|
| 490 | - ?> |
|
| 282 | + //filter _autosave_containers |
|
| 283 | + $containers = apply_filters('FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers', |
|
| 284 | + $this->_autosave_containers, $this); |
|
| 285 | + $containers = apply_filters('FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers', |
|
| 286 | + $containers, $this); |
|
| 287 | + |
|
| 288 | + wp_localize_script('event_editor_js', 'EE_AUTOSAVE_IDS', |
|
| 289 | + $containers); //todo once we enable autosaves, this needs to be switched to localize with "cpt-autosave" |
|
| 290 | + |
|
| 291 | + $unsaved_data_msg = array( |
|
| 292 | + 'eventmsg' => sprintf(__("The changes you made to this %s will be lost if you navigate away from this page.", |
|
| 293 | + 'event_espresso'), $this->_cpt_object->labels->singular_name), |
|
| 294 | + 'inputChanged' => 0, |
|
| 295 | + ); |
|
| 296 | + wp_localize_script('event_editor_js', 'UNSAVED_DATA_MSG', $unsaved_data_msg); |
|
| 297 | + } |
|
| 298 | + |
|
| 299 | + |
|
| 300 | + |
|
| 301 | + public function load_page_dependencies() |
|
| 302 | + { |
|
| 303 | + try { |
|
| 304 | + $this->_load_page_dependencies(); |
|
| 305 | + } catch (EE_Error $e) { |
|
| 306 | + $e->get_error(); |
|
| 307 | + } |
|
| 308 | + } |
|
| 309 | + |
|
| 310 | + |
|
| 311 | + |
|
| 312 | + /** |
|
| 313 | + * overloading the EE_Admin_Page parent load_page_dependencies so we can get the cpt stuff added in appropriately |
|
| 314 | + * |
|
| 315 | + * @access protected |
|
| 316 | + * @return void |
|
| 317 | + */ |
|
| 318 | + protected function _load_page_dependencies() |
|
| 319 | + { |
|
| 320 | + //we only add stuff if this is a cpt_route! |
|
| 321 | + if ( ! $this->_cpt_route) { |
|
| 322 | + parent::_load_page_dependencies(); |
|
| 323 | + return; |
|
| 324 | + } |
|
| 325 | + // now let's do some automatic filters into the wp_system |
|
| 326 | + // and we'll check to make sure the CHILD class |
|
| 327 | + // automatically has the required methods in place. |
|
| 328 | + // the following filters are for setting all the redirects |
|
| 329 | + // on DEFAULT WP custom post type actions |
|
| 330 | + // let's add a hidden input to the post-edit form |
|
| 331 | + // so we know when we have to trigger our custom redirects! |
|
| 332 | + // Otherwise the redirects will happen on ALL post saves which wouldn't be good of course! |
|
| 333 | + add_action('edit_form_after_title', array($this, 'cpt_post_form_hidden_input')); |
|
| 334 | + // inject our Admin page nav tabs... |
|
| 335 | + // let's make sure the nav tabs are set if they aren't already |
|
| 336 | + // if ( empty( $this->_nav_tabs ) ) $this->_set_nav_tabs(); |
|
| 337 | + add_action('post_edit_form_tag', array($this, 'inject_nav_tabs')); |
|
| 338 | + // modify the post_updated messages array |
|
| 339 | + add_action('post_updated_messages', array($this, 'post_update_messages'), 10); |
|
| 340 | + // add shortlink button to cpt edit screens. We can do this as a universal thing BECAUSE, |
|
| 341 | + // cpts use the same format for shortlinks as posts! |
|
| 342 | + add_filter('pre_get_shortlink', array($this, 'add_shortlink_button_to_editor'), 10, 4); |
|
| 343 | + // This basically allows us to change the title of the "publish" metabox area |
|
| 344 | + // on CPT pages by setting a 'publishbox' value in the $_labels property array in the child class. |
|
| 345 | + if ( ! empty($this->_labels['publishbox'])) { |
|
| 346 | + $box_label = is_array($this->_labels['publishbox']) |
|
| 347 | + && isset($this->_labels['publishbox'][$this->_req_action]) |
|
| 348 | + ? $this->_labels['publishbox'][$this->_req_action] |
|
| 349 | + : $this->_labels['publishbox']; |
|
| 350 | + add_meta_box( |
|
| 351 | + 'submitdiv', |
|
| 352 | + $box_label, |
|
| 353 | + 'post_submit_meta_box', |
|
| 354 | + $this->_cpt_routes[$this->_req_action], |
|
| 355 | + 'side', |
|
| 356 | + 'core' |
|
| 357 | + ); |
|
| 358 | + } |
|
| 359 | + //let's add page_templates metabox if this cpt added support for it. |
|
| 360 | + if ($this->_supports_page_templates($this->_cpt_object->name)) { |
|
| 361 | + add_meta_box( |
|
| 362 | + 'page_templates', |
|
| 363 | + __('Page Template', 'event_espresso'), |
|
| 364 | + array($this, 'page_template_meta_box'), |
|
| 365 | + $this->_cpt_routes[$this->_req_action], |
|
| 366 | + 'side', |
|
| 367 | + 'default' |
|
| 368 | + ); |
|
| 369 | + } |
|
| 370 | + //this is a filter that allows the addition of extra html after the permalink field on the wp post edit-form |
|
| 371 | + if (method_exists($this, 'extra_permalink_field_buttons')) { |
|
| 372 | + add_filter('get_sample_permalink_html', array($this, 'extra_permalink_field_buttons'), 10, 4); |
|
| 373 | + } |
|
| 374 | + //add preview button |
|
| 375 | + add_filter('get_sample_permalink_html', array($this, 'preview_button_html'), 5, 4); |
|
| 376 | + //insert our own post_stati dropdown |
|
| 377 | + add_action('post_submitbox_misc_actions', array($this, 'custom_post_stati_dropdown'), 10); |
|
| 378 | + //This allows adding additional information to the publish post submitbox on the wp post edit form |
|
| 379 | + if (method_exists($this, 'extra_misc_actions_publish_box')) { |
|
| 380 | + add_action('post_submitbox_misc_actions', array($this, 'extra_misc_actions_publish_box'), 10); |
|
| 381 | + } |
|
| 382 | + // This allows for adding additional stuff after the title field on the wp post edit form. |
|
| 383 | + // This is also before the wp_editor for post description field. |
|
| 384 | + if (method_exists($this, 'edit_form_after_title')) { |
|
| 385 | + add_action('edit_form_after_title', array($this, 'edit_form_after_title'), 10); |
|
| 386 | + } |
|
| 387 | + /** |
|
| 388 | + * Filtering WP's esc_url to capture urls pointing to core wp routes so they point to our route. |
|
| 389 | + */ |
|
| 390 | + add_filter('clean_url', array($this, 'switch_core_wp_urls_with_ours'), 10, 3); |
|
| 391 | + parent::_load_page_dependencies(); |
|
| 392 | + // notice we are ALSO going to load the pagenow hook set for this route |
|
| 393 | + // (see _before_page_setup for the reset of the pagenow global ). |
|
| 394 | + // This is for any plugins that are doing things properly |
|
| 395 | + // and hooking into the load page hook for core wp cpt routes. |
|
| 396 | + global $pagenow; |
|
| 397 | + do_action('load-' . $pagenow); |
|
| 398 | + $this->modify_current_screen(); |
|
| 399 | + add_action('admin_enqueue_scripts', array($this, 'setup_autosave_hooks'), 30); |
|
| 400 | + //we route REALLY early. |
|
| 401 | + try { |
|
| 402 | + $this->_route_admin_request(); |
|
| 403 | + } catch (EE_Error $e) { |
|
| 404 | + $e->get_error(); |
|
| 405 | + } |
|
| 406 | + } |
|
| 407 | + |
|
| 408 | + |
|
| 409 | + |
|
| 410 | + /** |
|
| 411 | + * Since we don't want users going to default core wp routes, this will check any wp urls run through the |
|
| 412 | + * esc_url() method and if we see a url matching a pattern for our routes, we'll modify it to point to OUR |
|
| 413 | + * route instead. |
|
| 414 | + * |
|
| 415 | + * @param string $good_protocol_url The escaped url. |
|
| 416 | + * @param string $original_url The original url. |
|
| 417 | + * @param string $_context The context sent to the esc_url method. |
|
| 418 | + * @return string possibly a new url for our route. |
|
| 419 | + */ |
|
| 420 | + public function switch_core_wp_urls_with_ours($good_protocol_url, $original_url, $_context) |
|
| 421 | + { |
|
| 422 | + $routes_to_match = array( |
|
| 423 | + 0 => array( |
|
| 424 | + 'edit.php?post_type=espresso_attendees', |
|
| 425 | + 'admin.php?page=espresso_registrations&action=contact_list', |
|
| 426 | + ), |
|
| 427 | + 1 => array( |
|
| 428 | + 'edit.php?post_type=' . $this->_cpt_object->name, |
|
| 429 | + 'admin.php?page=' . $this->_cpt_object->name, |
|
| 430 | + ), |
|
| 431 | + ); |
|
| 432 | + foreach ($routes_to_match as $route_matches) { |
|
| 433 | + if (strpos($good_protocol_url, $route_matches[0]) !== false) { |
|
| 434 | + return str_replace($route_matches[0], $route_matches[1], $good_protocol_url); |
|
| 435 | + } |
|
| 436 | + } |
|
| 437 | + return $good_protocol_url; |
|
| 438 | + } |
|
| 439 | + |
|
| 440 | + |
|
| 441 | + |
|
| 442 | + /** |
|
| 443 | + * Determine whether the current cpt supports page templates or not. |
|
| 444 | + * |
|
| 445 | + * @since %VER% |
|
| 446 | + * @param string $cpt_name The cpt slug we're checking on. |
|
| 447 | + * @return bool True supported, false not. |
|
| 448 | + */ |
|
| 449 | + private function _supports_page_templates($cpt_name) |
|
| 450 | + { |
|
| 451 | + |
|
| 452 | + $cpt_args = EE_Register_CPTs::get_CPTs(); |
|
| 453 | + $cpt_args = isset($cpt_args[$cpt_name]) ? $cpt_args[$cpt_name]['args'] : array(); |
|
| 454 | + $cpt_has_support = ! empty($cpt_args['page_templates']); |
|
| 455 | + |
|
| 456 | + //if the installed version of WP is > 4.7 we do some additional checks. |
|
| 457 | + if (EE_Recommended_Versions::check_wp_version('4.7','>=')) { |
|
| 458 | + $post_templates = wp_get_theme()->get_post_templates(); |
|
| 459 | + //if there are $post_templates for this cpt, then we return false for this method because |
|
| 460 | + //that means we aren't going to load our page template manager and leave that up to the native |
|
| 461 | + //cpt template manager. |
|
| 462 | + $cpt_has_support = ! isset($post_templates[$cpt_name]) ? $cpt_has_support : false; |
|
| 463 | + } |
|
| 464 | + |
|
| 465 | + return $cpt_has_support; |
|
| 466 | + } |
|
| 467 | + |
|
| 468 | + |
|
| 469 | + /** |
|
| 470 | + * Callback for the page_templates metabox selector. |
|
| 471 | + * |
|
| 472 | + * @since %VER% |
|
| 473 | + * @return void |
|
| 474 | + */ |
|
| 475 | + public function page_template_meta_box() |
|
| 476 | + { |
|
| 477 | + global $post; |
|
| 478 | + $template = ''; |
|
| 479 | + |
|
| 480 | + if (EE_Recommended_Versions::check_wp_version('4.7','>=')) { |
|
| 481 | + $page_template_count = count(get_page_templates()); |
|
| 482 | + } else { |
|
| 483 | + $page_template_count = count(get_page_templates($post)); |
|
| 484 | + }; |
|
| 485 | + |
|
| 486 | + if ($page_template_count) { |
|
| 487 | + $page_template = get_post_meta($post->ID, '_wp_page_template', true); |
|
| 488 | + $template = ! empty($page_template) ? $page_template : ''; |
|
| 489 | + } |
|
| 490 | + ?> |
|
| 491 | 491 | <p><strong><?php _e('Template') ?></strong></p> |
| 492 | 492 | <label class="screen-reader-text" for="page_template"><?php _e('Page Template') ?></label><select |
| 493 | 493 | name="page_template" id="page_template"> |
@@ -495,450 +495,450 @@ discard block |
||
| 495 | 495 | <?php page_template_dropdown($template); ?> |
| 496 | 496 | </select> |
| 497 | 497 | <?php |
| 498 | - } |
|
| 499 | - |
|
| 500 | - |
|
| 501 | - |
|
| 502 | - /** |
|
| 503 | - * if this post is a draft or scheduled post then we provide a preview button for user to click |
|
| 504 | - * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter. |
|
| 505 | - * |
|
| 506 | - * @param string $return the current html |
|
| 507 | - * @param int $id the post id for the page |
|
| 508 | - * @param string $new_title What the title is |
|
| 509 | - * @param string $new_slug what the slug is |
|
| 510 | - * @return string The new html string for the permalink area |
|
| 511 | - */ |
|
| 512 | - public function preview_button_html($return, $id, $new_title, $new_slug) |
|
| 513 | - { |
|
| 514 | - $post = get_post($id); |
|
| 515 | - if ('publish' !== get_post_status($post)) { |
|
| 516 | - //include shims for the `get_preview_post_link` function |
|
| 517 | - require_once( EE_CORE . 'wordpress-shims.php' ); |
|
| 518 | - $return .= '<span_id="view-post-btn"><a target="_blank" href="' |
|
| 519 | - . get_preview_post_link($id) |
|
| 520 | - . '" class="button button-small">' |
|
| 521 | - . __('Preview', 'event_espresso') |
|
| 522 | - . '</a></span>' |
|
| 523 | - . "\n"; |
|
| 524 | - } |
|
| 525 | - return $return; |
|
| 526 | - } |
|
| 527 | - |
|
| 528 | - |
|
| 529 | - |
|
| 530 | - /** |
|
| 531 | - * add our custom post stati dropdown on the wp post page for this cpt |
|
| 532 | - * |
|
| 533 | - * @return void |
|
| 534 | - */ |
|
| 535 | - public function custom_post_stati_dropdown() |
|
| 536 | - { |
|
| 537 | - |
|
| 538 | - $statuses = $this->_cpt_model_obj->get_custom_post_statuses(); |
|
| 539 | - $cur_status_label = array_key_exists($this->_cpt_model_obj->status(), $statuses) |
|
| 540 | - ? $statuses[$this->_cpt_model_obj->status()] |
|
| 541 | - : ''; |
|
| 542 | - $template_args = array( |
|
| 543 | - 'cur_status' => $this->_cpt_model_obj->status(), |
|
| 544 | - 'statuses' => $statuses, |
|
| 545 | - 'cur_status_label' => $cur_status_label, |
|
| 546 | - 'localized_status_save' => sprintf(__('Save %s', 'event_espresso'), $cur_status_label), |
|
| 547 | - ); |
|
| 548 | - //we'll add a trash post status (WP doesn't add one for some reason) |
|
| 549 | - if ($this->_cpt_model_obj->status() === 'trash') { |
|
| 550 | - $template_args['cur_status_label'] = __('Trashed', 'event_espresso'); |
|
| 551 | - $statuses['trash'] = __('Trashed', 'event_espresso'); |
|
| 552 | - $template_args['statuses'] = $statuses; |
|
| 553 | - } |
|
| 554 | - |
|
| 555 | - $template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php'; |
|
| 556 | - EEH_Template::display_template($template, $template_args); |
|
| 557 | - } |
|
| 558 | - |
|
| 559 | - |
|
| 560 | - |
|
| 561 | - public function setup_autosave_hooks() |
|
| 562 | - { |
|
| 563 | - $this->_set_autosave_containers(); |
|
| 564 | - $this->_load_autosave_scripts_styles(); |
|
| 565 | - } |
|
| 566 | - |
|
| 567 | - |
|
| 568 | - |
|
| 569 | - /** |
|
| 570 | - * This is run on all WordPress autosaves AFTER the autosave is complete and sends along a $_POST object (available |
|
| 571 | - * in $this->_req_data) containing: post_ID of the saved post autosavenonce for the saved post We'll do the check |
|
| 572 | - * for the nonce in here, but then this method looks for two things: |
|
| 573 | - * 1. Execute a method (if exists) matching 'ee_autosave_' and appended with the given route. OR |
|
| 574 | - * 2. do_actions() for global or class specific actions that have been registered (for plugins/addons not in an |
|
| 575 | - * EE_Admin_Page class. PLEASE NOTE: Data will be returned using the _return_json() object and so the |
|
| 576 | - * $_template_args property should be used to hold the $data array. We're expecting the following things set in |
|
| 577 | - * template args. |
|
| 578 | - * 1. $template_args['error'] = IF there is an error you can add the message in here. |
|
| 579 | - * 2. $template_args['data']['items'] = an array of items that are setup in key index pairs of 'where_values_go' |
|
| 580 | - * => 'values_to_add'. In other words, for the datetime metabox we'll have something like |
|
| 581 | - * $this->_template_args['data']['items'] = array( |
|
| 582 | - * 'event-datetime-ids' => '1,2,3'; |
|
| 583 | - * ); |
|
| 584 | - * Keep in mind the following things: |
|
| 585 | - * - "where" index is for the input with the id as that string. |
|
| 586 | - * - "what" index is what will be used for the value of that input. |
|
| 587 | - * |
|
| 588 | - * @return void |
|
| 589 | - */ |
|
| 590 | - public function do_extra_autosave_stuff() |
|
| 591 | - { |
|
| 592 | - //next let's check for the autosave nonce (we'll use _verify_nonce ) |
|
| 593 | - $nonce = isset($this->_req_data['autosavenonce']) |
|
| 594 | - ? $this->_req_data['autosavenonce'] |
|
| 595 | - : null; |
|
| 596 | - $this->_verify_nonce($nonce, 'autosave'); |
|
| 597 | - //make sure we define doing autosave (cause WP isn't triggering this we want to make sure we define it) |
|
| 598 | - if ( ! defined('DOING_AUTOSAVE')) { |
|
| 599 | - define('DOING_AUTOSAVE', true); |
|
| 600 | - } |
|
| 601 | - //if we made it here then the nonce checked out. Let's run our methods and actions |
|
| 602 | - $autosave = "_ee_autosave_{$this->_current_view}"; |
|
| 603 | - if (method_exists($this, $autosave)) { |
|
| 604 | - $this->$autosave(); |
|
| 605 | - } else { |
|
| 606 | - $this->_template_args['success'] = true; |
|
| 607 | - } |
|
| 608 | - do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this); |
|
| 609 | - do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this); |
|
| 610 | - //now let's return json |
|
| 611 | - $this->_return_json(); |
|
| 612 | - } |
|
| 613 | - |
|
| 614 | - |
|
| 615 | - |
|
| 616 | - /** |
|
| 617 | - * This takes care of setting up default routes and pages that utilize the core WP admin pages. |
|
| 618 | - * Child classes can override the defaults (in cases for adding metaboxes etc.) |
|
| 619 | - * but take care that you include the defaults here otherwise your core WP admin pages for the cpt won't work! |
|
| 620 | - * |
|
| 621 | - * @access protected |
|
| 622 | - * @throws EE_Error |
|
| 623 | - * @return void |
|
| 624 | - */ |
|
| 625 | - protected function _extend_page_config_for_cpt() |
|
| 626 | - { |
|
| 627 | - //before doing anything we need to make sure this runs ONLY when the loaded page matches the set page_slug |
|
| 628 | - if (isset($this->_req_data['page']) && $this->_req_data['page'] !== $this->page_slug) { |
|
| 629 | - return; |
|
| 630 | - } |
|
| 631 | - //set page routes and page config but ONLY if we're not viewing a custom setup cpt route as defined in _cpt_routes |
|
| 632 | - if ( ! empty($this->_cpt_object)) { |
|
| 633 | - $this->_page_routes = array_merge(array( |
|
| 634 | - 'create_new' => '_create_new_cpt_item', |
|
| 635 | - 'edit' => '_edit_cpt_item', |
|
| 636 | - ), $this->_page_routes); |
|
| 637 | - $this->_page_config = array_merge(array( |
|
| 638 | - 'create_new' => array( |
|
| 639 | - 'nav' => array( |
|
| 640 | - 'label' => $this->_cpt_object->labels->add_new_item, |
|
| 641 | - 'order' => 5, |
|
| 642 | - ), |
|
| 643 | - 'require_nonce' => false, |
|
| 644 | - ), |
|
| 645 | - 'edit' => array( |
|
| 646 | - 'nav' => array( |
|
| 647 | - 'label' => $this->_cpt_object->labels->edit_item, |
|
| 648 | - 'order' => 5, |
|
| 649 | - 'persistent' => false, |
|
| 650 | - 'url' => '', |
|
| 651 | - ), |
|
| 652 | - 'require_nonce' => false, |
|
| 653 | - ), |
|
| 654 | - ), |
|
| 655 | - $this->_page_config |
|
| 656 | - ); |
|
| 657 | - } |
|
| 658 | - //load the next section only if this is a matching cpt route as set in the cpt routes array. |
|
| 659 | - if ( ! isset($this->_cpt_routes[$this->_req_action])) { |
|
| 660 | - return; |
|
| 661 | - } |
|
| 662 | - $this->_cpt_route = isset($this->_cpt_routes[$this->_req_action]) ? true : false; |
|
| 663 | - //add_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', array( $this, 'modify_current_screen') ); |
|
| 664 | - if (empty($this->_cpt_object)) { |
|
| 665 | - $msg = sprintf(__('This page has been set as being related to a registered custom post type, however, the custom post type object could not be retrieved. There are two possible reasons for this: 1. The "%s" does not match a registered post type. or 2. The custom post type is not registered for the "%s" action as indexed in the "$_cpt_routes" property on this class (%s).'), |
|
| 666 | - $this->page_slug, $this->_req_action, get_class($this)); |
|
| 667 | - throw new EE_Error($msg); |
|
| 668 | - } |
|
| 669 | - if ($this->_cpt_route) { |
|
| 670 | - $id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null; |
|
| 671 | - $this->_set_model_object($id); |
|
| 672 | - } |
|
| 673 | - } |
|
| 674 | - |
|
| 675 | - |
|
| 676 | - |
|
| 677 | - /** |
|
| 678 | - * Sets the _cpt_model_object property using what has been set for the _cpt_model_name and a given id. |
|
| 679 | - * |
|
| 680 | - * @access protected |
|
| 681 | - * @param int $id The id to retrieve the model object for. If empty we set a default object. |
|
| 682 | - * @param bool $ignore_route_check |
|
| 683 | - * @param string $req_type whether the current route is for inserting, updating, or deleting the CPT |
|
| 684 | - * @throws EE_Error |
|
| 685 | - */ |
|
| 686 | - protected function _set_model_object($id = null, $ignore_route_check = false, $req_type = '') |
|
| 687 | - { |
|
| 688 | - $model = null; |
|
| 689 | - if ( |
|
| 690 | - empty($this->_cpt_model_names) |
|
| 691 | - || ( |
|
| 692 | - ! $ignore_route_check |
|
| 693 | - && ! isset($this->_cpt_routes[$this->_req_action]) |
|
| 694 | - ) || ( |
|
| 695 | - $this->_cpt_model_obj instanceof EE_CPT_Base |
|
| 696 | - && $this->_cpt_model_obj->ID() === $id |
|
| 697 | - ) |
|
| 698 | - ) { |
|
| 699 | - //get out cuz we either don't have a model name OR the object has already been set and it has the same id as what has been sent. |
|
| 700 | - return; |
|
| 701 | - } |
|
| 702 | - //if ignore_route_check is true, then get the model name via EE_Register_CPTs |
|
| 703 | - if ($ignore_route_check) { |
|
| 704 | - $model_names = EE_Register_CPTs::get_cpt_model_names(); |
|
| 705 | - $post_type = get_post_type($id); |
|
| 706 | - if (isset($model_names[$post_type])) { |
|
| 707 | - $model = EE_Registry::instance()->load_model($model_names[$post_type]); |
|
| 708 | - } |
|
| 709 | - } else { |
|
| 710 | - $model = EE_Registry::instance()->load_model($this->_cpt_model_names[$this->_req_action]); |
|
| 711 | - } |
|
| 712 | - if ($model instanceof EEM_Base) { |
|
| 713 | - $this->_cpt_model_obj = ! empty($id) ? $model->get_one_by_ID($id) : $model->create_default_object(); |
|
| 714 | - } |
|
| 715 | - do_action( |
|
| 716 | - 'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object', |
|
| 717 | - $this->_cpt_model_obj, |
|
| 718 | - $req_type |
|
| 719 | - ); |
|
| 720 | - } |
|
| 721 | - |
|
| 722 | - |
|
| 723 | - |
|
| 724 | - /** |
|
| 725 | - * admin_init_global |
|
| 726 | - * This runs all the code that we want executed within the WP admin_init hook. |
|
| 727 | - * This method executes for ALL EE Admin pages. |
|
| 728 | - * |
|
| 729 | - * @access public |
|
| 730 | - * @return void |
|
| 731 | - */ |
|
| 732 | - public function admin_init_global() |
|
| 733 | - { |
|
| 734 | - $post = isset($this->_req_data['post']) ? get_post($this->_req_data['post']) : null; |
|
| 735 | - //its possible this is a new save so let's catch that instead |
|
| 736 | - $post = isset($this->_req_data['post_ID']) ? get_post($this->_req_data['post_ID']) : $post; |
|
| 737 | - $post_type = $post ? $post->post_type : false; |
|
| 738 | - $current_route = isset($this->_req_data['current_route']) |
|
| 739 | - ? $this->_req_data['current_route'] |
|
| 740 | - : 'shouldneverwork'; |
|
| 741 | - $route_to_check = $post_type && isset($this->_cpt_routes[$current_route]) |
|
| 742 | - ? $this->_cpt_routes[$current_route] |
|
| 743 | - : ''; |
|
| 744 | - add_filter('get_delete_post_link', array($this, 'modify_delete_post_link'), 10, 3); |
|
| 745 | - add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 3); |
|
| 746 | - if ($post_type === $route_to_check) { |
|
| 747 | - add_filter('redirect_post_location', array($this, 'cpt_post_location_redirect'), 10, 2); |
|
| 748 | - } |
|
| 749 | - //now let's filter redirect if we're on a revision page and the revision is for an event CPT. |
|
| 750 | - $revision = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null; |
|
| 751 | - if ( ! empty($revision)) { |
|
| 752 | - $action = isset($this->_req_data['action']) ? $this->_req_data['action'] : null; |
|
| 753 | - //doing a restore? |
|
| 754 | - if ( ! empty($action) && $action === 'restore') { |
|
| 755 | - //get post for revision |
|
| 756 | - $rev_post = get_post($revision); |
|
| 757 | - $rev_parent = get_post($rev_post->post_parent); |
|
| 758 | - //only do our redirect filter AND our restore revision action if the post_type for the parent is one of our cpts. |
|
| 759 | - if ($rev_parent && $rev_parent->post_type === $this->page_slug) { |
|
| 760 | - add_filter('wp_redirect', array($this, 'revision_redirect'), 10, 2); |
|
| 761 | - //restores of revisions |
|
| 762 | - add_action('wp_restore_post_revision', array($this, 'restore_revision'), 10, 2); |
|
| 763 | - } |
|
| 764 | - } |
|
| 765 | - } |
|
| 766 | - //NOTE we ONLY want to run these hooks if we're on the right class for the given post type. Otherwise we could see some really freaky things happen! |
|
| 767 | - if ($post_type && $post_type === $route_to_check) { |
|
| 768 | - //$post_id, $post |
|
| 769 | - add_action('save_post', array($this, 'insert_update'), 10, 3); |
|
| 770 | - //$post_id |
|
| 771 | - add_action('trashed_post', array($this, 'before_trash_cpt_item'), 10); |
|
| 772 | - add_action('trashed_post', array($this, 'dont_permanently_delete_ee_cpts'), 10); |
|
| 773 | - add_action('untrashed_post', array($this, 'before_restore_cpt_item'), 10); |
|
| 774 | - add_action('after_delete_post', array($this, 'before_delete_cpt_item'), 10); |
|
| 775 | - } |
|
| 776 | - } |
|
| 777 | - |
|
| 778 | - |
|
| 779 | - |
|
| 780 | - /** |
|
| 781 | - * Callback for the WordPress trashed_post hook. |
|
| 782 | - * Execute some basic checks before calling the trash_cpt_item declared in the child class. |
|
| 783 | - * |
|
| 784 | - * @param int $post_id |
|
| 785 | - * @throws \EE_Error |
|
| 786 | - */ |
|
| 787 | - public function before_trash_cpt_item($post_id) |
|
| 788 | - { |
|
| 789 | - $this->_set_model_object($post_id, true, 'trash'); |
|
| 790 | - //if our cpt object isn't existent then get out immediately. |
|
| 791 | - if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) { |
|
| 792 | - return; |
|
| 793 | - } |
|
| 794 | - $this->trash_cpt_item($post_id); |
|
| 795 | - } |
|
| 796 | - |
|
| 797 | - |
|
| 798 | - |
|
| 799 | - /** |
|
| 800 | - * Callback for the WordPress untrashed_post hook. |
|
| 801 | - * Execute some basic checks before calling the restore_cpt_method in the child class. |
|
| 802 | - * |
|
| 803 | - * @param $post_id |
|
| 804 | - * @throws \EE_Error |
|
| 805 | - */ |
|
| 806 | - public function before_restore_cpt_item($post_id) |
|
| 807 | - { |
|
| 808 | - $this->_set_model_object($post_id, true, 'restore'); |
|
| 809 | - //if our cpt object isn't existent then get out immediately. |
|
| 810 | - if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) { |
|
| 811 | - return; |
|
| 812 | - } |
|
| 813 | - $this->restore_cpt_item($post_id); |
|
| 814 | - } |
|
| 815 | - |
|
| 816 | - |
|
| 817 | - |
|
| 818 | - /** |
|
| 819 | - * Callback for the WordPress after_delete_post hook. |
|
| 820 | - * Execute some basic checks before calling the delete_cpt_item method in the child class. |
|
| 821 | - * |
|
| 822 | - * @param $post_id |
|
| 823 | - * @throws \EE_Error |
|
| 824 | - */ |
|
| 825 | - public function before_delete_cpt_item($post_id) |
|
| 826 | - { |
|
| 827 | - $this->_set_model_object($post_id, true, 'delete'); |
|
| 828 | - //if our cpt object isn't existent then get out immediately. |
|
| 829 | - if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) { |
|
| 830 | - return; |
|
| 831 | - } |
|
| 832 | - $this->delete_cpt_item($post_id); |
|
| 833 | - } |
|
| 834 | - |
|
| 835 | - |
|
| 836 | - |
|
| 837 | - /** |
|
| 838 | - * This simply verifies if the cpt_model_object is instantiated for the given page and throws an error message |
|
| 839 | - * accordingly. |
|
| 840 | - * |
|
| 841 | - * @access public |
|
| 842 | - * @throws EE_Error |
|
| 843 | - * @return void |
|
| 844 | - */ |
|
| 845 | - public function verify_cpt_object() |
|
| 846 | - { |
|
| 847 | - $label = ! empty($this->_cpt_object) ? $this->_cpt_object->labels->singular_name : $this->page_label; |
|
| 848 | - // verify event object |
|
| 849 | - if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) { |
|
| 850 | - throw new EE_Error(sprintf(__('Something has gone wrong with the page load because we are unable to set up the object for the %1$s. This usually happens when the given id for the page route is NOT for the correct custom post type for this page', |
|
| 851 | - 'event_espresso'), $label)); |
|
| 852 | - } |
|
| 853 | - //if auto-draft then throw an error |
|
| 854 | - if ($this->_cpt_model_obj->get('status') === 'auto-draft') { |
|
| 855 | - EE_Error::overwrite_errors(); |
|
| 856 | - EE_Error::add_error(sprintf(__('This %1$s was saved without a title, description, or excerpt which means that none of the extra details you added were saved properly. All autodrafts will show up in the "draft" view of your event list table. You can delete them from there. Please click the "Add %1$s" button to refresh and restart.'), |
|
| 857 | - $label), __FILE__, __FUNCTION__, __LINE__); |
|
| 858 | - } |
|
| 859 | - } |
|
| 860 | - |
|
| 861 | - |
|
| 862 | - |
|
| 863 | - /** |
|
| 864 | - * admin_footer_scripts_global |
|
| 865 | - * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method |
|
| 866 | - * will apply on ALL EE_Admin pages. |
|
| 867 | - * |
|
| 868 | - * @access public |
|
| 869 | - * @return void |
|
| 870 | - */ |
|
| 871 | - public function admin_footer_scripts_global() |
|
| 872 | - { |
|
| 873 | - $this->_add_admin_page_ajax_loading_img(); |
|
| 874 | - $this->_add_admin_page_overlay(); |
|
| 875 | - } |
|
| 876 | - |
|
| 877 | - |
|
| 878 | - |
|
| 879 | - /** |
|
| 880 | - * add in any global scripts for cpt routes |
|
| 881 | - * |
|
| 882 | - * @return void |
|
| 883 | - */ |
|
| 884 | - public function load_global_scripts_styles() |
|
| 885 | - { |
|
| 886 | - parent::load_global_scripts_styles(); |
|
| 887 | - if ($this->_cpt_model_obj instanceof EE_CPT_Base) { |
|
| 888 | - //setup custom post status object for localize script but only if we've got a cpt object |
|
| 889 | - $statuses = $this->_cpt_model_obj->get_custom_post_statuses(); |
|
| 890 | - if ( ! empty($statuses)) { |
|
| 891 | - //get ALL statuses! |
|
| 892 | - $statuses = $this->_cpt_model_obj->get_all_post_statuses(); |
|
| 893 | - //setup object |
|
| 894 | - $ee_cpt_statuses = array(); |
|
| 895 | - foreach ($statuses as $status => $label) { |
|
| 896 | - $ee_cpt_statuses[$status] = array( |
|
| 897 | - 'label' => $label, |
|
| 898 | - 'save_label' => sprintf(__('Save as %s', 'event_espresso'), $label), |
|
| 899 | - ); |
|
| 900 | - } |
|
| 901 | - wp_localize_script('ee_admin_js', 'eeCPTstatuses', $ee_cpt_statuses); |
|
| 902 | - } |
|
| 903 | - } |
|
| 904 | - } |
|
| 905 | - |
|
| 906 | - |
|
| 907 | - |
|
| 908 | - /** |
|
| 909 | - * This is a wrapper for the insert/update routes for cpt items so we can add things that are common to ALL |
|
| 910 | - * insert/updates |
|
| 911 | - * |
|
| 912 | - * @param int $post_id ID of post being updated |
|
| 913 | - * @param WP_Post $post Post object from WP |
|
| 914 | - * @param bool $update Whether this is an update or a new save. |
|
| 915 | - * @return void |
|
| 916 | - * @throws \EE_Error |
|
| 917 | - */ |
|
| 918 | - public function insert_update($post_id, $post, $update) |
|
| 919 | - { |
|
| 920 | - //make sure that if this is a revision OR trash action that we don't do any updates! |
|
| 921 | - if ( |
|
| 922 | - isset($this->_req_data['action']) |
|
| 923 | - && ( |
|
| 924 | - $this->_req_data['action'] === 'restore' |
|
| 925 | - || $this->_req_data['action'] === 'trash' |
|
| 926 | - ) |
|
| 927 | - ) { |
|
| 928 | - return; |
|
| 929 | - } |
|
| 930 | - $this->_set_model_object($post_id, true, 'insert_update'); |
|
| 931 | - //if our cpt object is not instantiated and its NOT the same post_id as what is triggering this callback, then exit. |
|
| 932 | - if ($update |
|
| 933 | - && ( |
|
| 934 | - ! $this->_cpt_model_obj instanceof EE_CPT_Base |
|
| 935 | - || $this->_cpt_model_obj->ID() !== $post_id |
|
| 936 | - ) |
|
| 937 | - ) { |
|
| 938 | - return; |
|
| 939 | - } |
|
| 940 | - //check for autosave and update our req_data property accordingly. |
|
| 941 | - /*if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE && isset( $this->_req_data['ee_autosave_data'] ) ) { |
|
| 498 | + } |
|
| 499 | + |
|
| 500 | + |
|
| 501 | + |
|
| 502 | + /** |
|
| 503 | + * if this post is a draft or scheduled post then we provide a preview button for user to click |
|
| 504 | + * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter. |
|
| 505 | + * |
|
| 506 | + * @param string $return the current html |
|
| 507 | + * @param int $id the post id for the page |
|
| 508 | + * @param string $new_title What the title is |
|
| 509 | + * @param string $new_slug what the slug is |
|
| 510 | + * @return string The new html string for the permalink area |
|
| 511 | + */ |
|
| 512 | + public function preview_button_html($return, $id, $new_title, $new_slug) |
|
| 513 | + { |
|
| 514 | + $post = get_post($id); |
|
| 515 | + if ('publish' !== get_post_status($post)) { |
|
| 516 | + //include shims for the `get_preview_post_link` function |
|
| 517 | + require_once( EE_CORE . 'wordpress-shims.php' ); |
|
| 518 | + $return .= '<span_id="view-post-btn"><a target="_blank" href="' |
|
| 519 | + . get_preview_post_link($id) |
|
| 520 | + . '" class="button button-small">' |
|
| 521 | + . __('Preview', 'event_espresso') |
|
| 522 | + . '</a></span>' |
|
| 523 | + . "\n"; |
|
| 524 | + } |
|
| 525 | + return $return; |
|
| 526 | + } |
|
| 527 | + |
|
| 528 | + |
|
| 529 | + |
|
| 530 | + /** |
|
| 531 | + * add our custom post stati dropdown on the wp post page for this cpt |
|
| 532 | + * |
|
| 533 | + * @return void |
|
| 534 | + */ |
|
| 535 | + public function custom_post_stati_dropdown() |
|
| 536 | + { |
|
| 537 | + |
|
| 538 | + $statuses = $this->_cpt_model_obj->get_custom_post_statuses(); |
|
| 539 | + $cur_status_label = array_key_exists($this->_cpt_model_obj->status(), $statuses) |
|
| 540 | + ? $statuses[$this->_cpt_model_obj->status()] |
|
| 541 | + : ''; |
|
| 542 | + $template_args = array( |
|
| 543 | + 'cur_status' => $this->_cpt_model_obj->status(), |
|
| 544 | + 'statuses' => $statuses, |
|
| 545 | + 'cur_status_label' => $cur_status_label, |
|
| 546 | + 'localized_status_save' => sprintf(__('Save %s', 'event_espresso'), $cur_status_label), |
|
| 547 | + ); |
|
| 548 | + //we'll add a trash post status (WP doesn't add one for some reason) |
|
| 549 | + if ($this->_cpt_model_obj->status() === 'trash') { |
|
| 550 | + $template_args['cur_status_label'] = __('Trashed', 'event_espresso'); |
|
| 551 | + $statuses['trash'] = __('Trashed', 'event_espresso'); |
|
| 552 | + $template_args['statuses'] = $statuses; |
|
| 553 | + } |
|
| 554 | + |
|
| 555 | + $template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php'; |
|
| 556 | + EEH_Template::display_template($template, $template_args); |
|
| 557 | + } |
|
| 558 | + |
|
| 559 | + |
|
| 560 | + |
|
| 561 | + public function setup_autosave_hooks() |
|
| 562 | + { |
|
| 563 | + $this->_set_autosave_containers(); |
|
| 564 | + $this->_load_autosave_scripts_styles(); |
|
| 565 | + } |
|
| 566 | + |
|
| 567 | + |
|
| 568 | + |
|
| 569 | + /** |
|
| 570 | + * This is run on all WordPress autosaves AFTER the autosave is complete and sends along a $_POST object (available |
|
| 571 | + * in $this->_req_data) containing: post_ID of the saved post autosavenonce for the saved post We'll do the check |
|
| 572 | + * for the nonce in here, but then this method looks for two things: |
|
| 573 | + * 1. Execute a method (if exists) matching 'ee_autosave_' and appended with the given route. OR |
|
| 574 | + * 2. do_actions() for global or class specific actions that have been registered (for plugins/addons not in an |
|
| 575 | + * EE_Admin_Page class. PLEASE NOTE: Data will be returned using the _return_json() object and so the |
|
| 576 | + * $_template_args property should be used to hold the $data array. We're expecting the following things set in |
|
| 577 | + * template args. |
|
| 578 | + * 1. $template_args['error'] = IF there is an error you can add the message in here. |
|
| 579 | + * 2. $template_args['data']['items'] = an array of items that are setup in key index pairs of 'where_values_go' |
|
| 580 | + * => 'values_to_add'. In other words, for the datetime metabox we'll have something like |
|
| 581 | + * $this->_template_args['data']['items'] = array( |
|
| 582 | + * 'event-datetime-ids' => '1,2,3'; |
|
| 583 | + * ); |
|
| 584 | + * Keep in mind the following things: |
|
| 585 | + * - "where" index is for the input with the id as that string. |
|
| 586 | + * - "what" index is what will be used for the value of that input. |
|
| 587 | + * |
|
| 588 | + * @return void |
|
| 589 | + */ |
|
| 590 | + public function do_extra_autosave_stuff() |
|
| 591 | + { |
|
| 592 | + //next let's check for the autosave nonce (we'll use _verify_nonce ) |
|
| 593 | + $nonce = isset($this->_req_data['autosavenonce']) |
|
| 594 | + ? $this->_req_data['autosavenonce'] |
|
| 595 | + : null; |
|
| 596 | + $this->_verify_nonce($nonce, 'autosave'); |
|
| 597 | + //make sure we define doing autosave (cause WP isn't triggering this we want to make sure we define it) |
|
| 598 | + if ( ! defined('DOING_AUTOSAVE')) { |
|
| 599 | + define('DOING_AUTOSAVE', true); |
|
| 600 | + } |
|
| 601 | + //if we made it here then the nonce checked out. Let's run our methods and actions |
|
| 602 | + $autosave = "_ee_autosave_{$this->_current_view}"; |
|
| 603 | + if (method_exists($this, $autosave)) { |
|
| 604 | + $this->$autosave(); |
|
| 605 | + } else { |
|
| 606 | + $this->_template_args['success'] = true; |
|
| 607 | + } |
|
| 608 | + do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this); |
|
| 609 | + do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this); |
|
| 610 | + //now let's return json |
|
| 611 | + $this->_return_json(); |
|
| 612 | + } |
|
| 613 | + |
|
| 614 | + |
|
| 615 | + |
|
| 616 | + /** |
|
| 617 | + * This takes care of setting up default routes and pages that utilize the core WP admin pages. |
|
| 618 | + * Child classes can override the defaults (in cases for adding metaboxes etc.) |
|
| 619 | + * but take care that you include the defaults here otherwise your core WP admin pages for the cpt won't work! |
|
| 620 | + * |
|
| 621 | + * @access protected |
|
| 622 | + * @throws EE_Error |
|
| 623 | + * @return void |
|
| 624 | + */ |
|
| 625 | + protected function _extend_page_config_for_cpt() |
|
| 626 | + { |
|
| 627 | + //before doing anything we need to make sure this runs ONLY when the loaded page matches the set page_slug |
|
| 628 | + if (isset($this->_req_data['page']) && $this->_req_data['page'] !== $this->page_slug) { |
|
| 629 | + return; |
|
| 630 | + } |
|
| 631 | + //set page routes and page config but ONLY if we're not viewing a custom setup cpt route as defined in _cpt_routes |
|
| 632 | + if ( ! empty($this->_cpt_object)) { |
|
| 633 | + $this->_page_routes = array_merge(array( |
|
| 634 | + 'create_new' => '_create_new_cpt_item', |
|
| 635 | + 'edit' => '_edit_cpt_item', |
|
| 636 | + ), $this->_page_routes); |
|
| 637 | + $this->_page_config = array_merge(array( |
|
| 638 | + 'create_new' => array( |
|
| 639 | + 'nav' => array( |
|
| 640 | + 'label' => $this->_cpt_object->labels->add_new_item, |
|
| 641 | + 'order' => 5, |
|
| 642 | + ), |
|
| 643 | + 'require_nonce' => false, |
|
| 644 | + ), |
|
| 645 | + 'edit' => array( |
|
| 646 | + 'nav' => array( |
|
| 647 | + 'label' => $this->_cpt_object->labels->edit_item, |
|
| 648 | + 'order' => 5, |
|
| 649 | + 'persistent' => false, |
|
| 650 | + 'url' => '', |
|
| 651 | + ), |
|
| 652 | + 'require_nonce' => false, |
|
| 653 | + ), |
|
| 654 | + ), |
|
| 655 | + $this->_page_config |
|
| 656 | + ); |
|
| 657 | + } |
|
| 658 | + //load the next section only if this is a matching cpt route as set in the cpt routes array. |
|
| 659 | + if ( ! isset($this->_cpt_routes[$this->_req_action])) { |
|
| 660 | + return; |
|
| 661 | + } |
|
| 662 | + $this->_cpt_route = isset($this->_cpt_routes[$this->_req_action]) ? true : false; |
|
| 663 | + //add_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', array( $this, 'modify_current_screen') ); |
|
| 664 | + if (empty($this->_cpt_object)) { |
|
| 665 | + $msg = sprintf(__('This page has been set as being related to a registered custom post type, however, the custom post type object could not be retrieved. There are two possible reasons for this: 1. The "%s" does not match a registered post type. or 2. The custom post type is not registered for the "%s" action as indexed in the "$_cpt_routes" property on this class (%s).'), |
|
| 666 | + $this->page_slug, $this->_req_action, get_class($this)); |
|
| 667 | + throw new EE_Error($msg); |
|
| 668 | + } |
|
| 669 | + if ($this->_cpt_route) { |
|
| 670 | + $id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null; |
|
| 671 | + $this->_set_model_object($id); |
|
| 672 | + } |
|
| 673 | + } |
|
| 674 | + |
|
| 675 | + |
|
| 676 | + |
|
| 677 | + /** |
|
| 678 | + * Sets the _cpt_model_object property using what has been set for the _cpt_model_name and a given id. |
|
| 679 | + * |
|
| 680 | + * @access protected |
|
| 681 | + * @param int $id The id to retrieve the model object for. If empty we set a default object. |
|
| 682 | + * @param bool $ignore_route_check |
|
| 683 | + * @param string $req_type whether the current route is for inserting, updating, or deleting the CPT |
|
| 684 | + * @throws EE_Error |
|
| 685 | + */ |
|
| 686 | + protected function _set_model_object($id = null, $ignore_route_check = false, $req_type = '') |
|
| 687 | + { |
|
| 688 | + $model = null; |
|
| 689 | + if ( |
|
| 690 | + empty($this->_cpt_model_names) |
|
| 691 | + || ( |
|
| 692 | + ! $ignore_route_check |
|
| 693 | + && ! isset($this->_cpt_routes[$this->_req_action]) |
|
| 694 | + ) || ( |
|
| 695 | + $this->_cpt_model_obj instanceof EE_CPT_Base |
|
| 696 | + && $this->_cpt_model_obj->ID() === $id |
|
| 697 | + ) |
|
| 698 | + ) { |
|
| 699 | + //get out cuz we either don't have a model name OR the object has already been set and it has the same id as what has been sent. |
|
| 700 | + return; |
|
| 701 | + } |
|
| 702 | + //if ignore_route_check is true, then get the model name via EE_Register_CPTs |
|
| 703 | + if ($ignore_route_check) { |
|
| 704 | + $model_names = EE_Register_CPTs::get_cpt_model_names(); |
|
| 705 | + $post_type = get_post_type($id); |
|
| 706 | + if (isset($model_names[$post_type])) { |
|
| 707 | + $model = EE_Registry::instance()->load_model($model_names[$post_type]); |
|
| 708 | + } |
|
| 709 | + } else { |
|
| 710 | + $model = EE_Registry::instance()->load_model($this->_cpt_model_names[$this->_req_action]); |
|
| 711 | + } |
|
| 712 | + if ($model instanceof EEM_Base) { |
|
| 713 | + $this->_cpt_model_obj = ! empty($id) ? $model->get_one_by_ID($id) : $model->create_default_object(); |
|
| 714 | + } |
|
| 715 | + do_action( |
|
| 716 | + 'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object', |
|
| 717 | + $this->_cpt_model_obj, |
|
| 718 | + $req_type |
|
| 719 | + ); |
|
| 720 | + } |
|
| 721 | + |
|
| 722 | + |
|
| 723 | + |
|
| 724 | + /** |
|
| 725 | + * admin_init_global |
|
| 726 | + * This runs all the code that we want executed within the WP admin_init hook. |
|
| 727 | + * This method executes for ALL EE Admin pages. |
|
| 728 | + * |
|
| 729 | + * @access public |
|
| 730 | + * @return void |
|
| 731 | + */ |
|
| 732 | + public function admin_init_global() |
|
| 733 | + { |
|
| 734 | + $post = isset($this->_req_data['post']) ? get_post($this->_req_data['post']) : null; |
|
| 735 | + //its possible this is a new save so let's catch that instead |
|
| 736 | + $post = isset($this->_req_data['post_ID']) ? get_post($this->_req_data['post_ID']) : $post; |
|
| 737 | + $post_type = $post ? $post->post_type : false; |
|
| 738 | + $current_route = isset($this->_req_data['current_route']) |
|
| 739 | + ? $this->_req_data['current_route'] |
|
| 740 | + : 'shouldneverwork'; |
|
| 741 | + $route_to_check = $post_type && isset($this->_cpt_routes[$current_route]) |
|
| 742 | + ? $this->_cpt_routes[$current_route] |
|
| 743 | + : ''; |
|
| 744 | + add_filter('get_delete_post_link', array($this, 'modify_delete_post_link'), 10, 3); |
|
| 745 | + add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 3); |
|
| 746 | + if ($post_type === $route_to_check) { |
|
| 747 | + add_filter('redirect_post_location', array($this, 'cpt_post_location_redirect'), 10, 2); |
|
| 748 | + } |
|
| 749 | + //now let's filter redirect if we're on a revision page and the revision is for an event CPT. |
|
| 750 | + $revision = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null; |
|
| 751 | + if ( ! empty($revision)) { |
|
| 752 | + $action = isset($this->_req_data['action']) ? $this->_req_data['action'] : null; |
|
| 753 | + //doing a restore? |
|
| 754 | + if ( ! empty($action) && $action === 'restore') { |
|
| 755 | + //get post for revision |
|
| 756 | + $rev_post = get_post($revision); |
|
| 757 | + $rev_parent = get_post($rev_post->post_parent); |
|
| 758 | + //only do our redirect filter AND our restore revision action if the post_type for the parent is one of our cpts. |
|
| 759 | + if ($rev_parent && $rev_parent->post_type === $this->page_slug) { |
|
| 760 | + add_filter('wp_redirect', array($this, 'revision_redirect'), 10, 2); |
|
| 761 | + //restores of revisions |
|
| 762 | + add_action('wp_restore_post_revision', array($this, 'restore_revision'), 10, 2); |
|
| 763 | + } |
|
| 764 | + } |
|
| 765 | + } |
|
| 766 | + //NOTE we ONLY want to run these hooks if we're on the right class for the given post type. Otherwise we could see some really freaky things happen! |
|
| 767 | + if ($post_type && $post_type === $route_to_check) { |
|
| 768 | + //$post_id, $post |
|
| 769 | + add_action('save_post', array($this, 'insert_update'), 10, 3); |
|
| 770 | + //$post_id |
|
| 771 | + add_action('trashed_post', array($this, 'before_trash_cpt_item'), 10); |
|
| 772 | + add_action('trashed_post', array($this, 'dont_permanently_delete_ee_cpts'), 10); |
|
| 773 | + add_action('untrashed_post', array($this, 'before_restore_cpt_item'), 10); |
|
| 774 | + add_action('after_delete_post', array($this, 'before_delete_cpt_item'), 10); |
|
| 775 | + } |
|
| 776 | + } |
|
| 777 | + |
|
| 778 | + |
|
| 779 | + |
|
| 780 | + /** |
|
| 781 | + * Callback for the WordPress trashed_post hook. |
|
| 782 | + * Execute some basic checks before calling the trash_cpt_item declared in the child class. |
|
| 783 | + * |
|
| 784 | + * @param int $post_id |
|
| 785 | + * @throws \EE_Error |
|
| 786 | + */ |
|
| 787 | + public function before_trash_cpt_item($post_id) |
|
| 788 | + { |
|
| 789 | + $this->_set_model_object($post_id, true, 'trash'); |
|
| 790 | + //if our cpt object isn't existent then get out immediately. |
|
| 791 | + if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) { |
|
| 792 | + return; |
|
| 793 | + } |
|
| 794 | + $this->trash_cpt_item($post_id); |
|
| 795 | + } |
|
| 796 | + |
|
| 797 | + |
|
| 798 | + |
|
| 799 | + /** |
|
| 800 | + * Callback for the WordPress untrashed_post hook. |
|
| 801 | + * Execute some basic checks before calling the restore_cpt_method in the child class. |
|
| 802 | + * |
|
| 803 | + * @param $post_id |
|
| 804 | + * @throws \EE_Error |
|
| 805 | + */ |
|
| 806 | + public function before_restore_cpt_item($post_id) |
|
| 807 | + { |
|
| 808 | + $this->_set_model_object($post_id, true, 'restore'); |
|
| 809 | + //if our cpt object isn't existent then get out immediately. |
|
| 810 | + if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) { |
|
| 811 | + return; |
|
| 812 | + } |
|
| 813 | + $this->restore_cpt_item($post_id); |
|
| 814 | + } |
|
| 815 | + |
|
| 816 | + |
|
| 817 | + |
|
| 818 | + /** |
|
| 819 | + * Callback for the WordPress after_delete_post hook. |
|
| 820 | + * Execute some basic checks before calling the delete_cpt_item method in the child class. |
|
| 821 | + * |
|
| 822 | + * @param $post_id |
|
| 823 | + * @throws \EE_Error |
|
| 824 | + */ |
|
| 825 | + public function before_delete_cpt_item($post_id) |
|
| 826 | + { |
|
| 827 | + $this->_set_model_object($post_id, true, 'delete'); |
|
| 828 | + //if our cpt object isn't existent then get out immediately. |
|
| 829 | + if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) { |
|
| 830 | + return; |
|
| 831 | + } |
|
| 832 | + $this->delete_cpt_item($post_id); |
|
| 833 | + } |
|
| 834 | + |
|
| 835 | + |
|
| 836 | + |
|
| 837 | + /** |
|
| 838 | + * This simply verifies if the cpt_model_object is instantiated for the given page and throws an error message |
|
| 839 | + * accordingly. |
|
| 840 | + * |
|
| 841 | + * @access public |
|
| 842 | + * @throws EE_Error |
|
| 843 | + * @return void |
|
| 844 | + */ |
|
| 845 | + public function verify_cpt_object() |
|
| 846 | + { |
|
| 847 | + $label = ! empty($this->_cpt_object) ? $this->_cpt_object->labels->singular_name : $this->page_label; |
|
| 848 | + // verify event object |
|
| 849 | + if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) { |
|
| 850 | + throw new EE_Error(sprintf(__('Something has gone wrong with the page load because we are unable to set up the object for the %1$s. This usually happens when the given id for the page route is NOT for the correct custom post type for this page', |
|
| 851 | + 'event_espresso'), $label)); |
|
| 852 | + } |
|
| 853 | + //if auto-draft then throw an error |
|
| 854 | + if ($this->_cpt_model_obj->get('status') === 'auto-draft') { |
|
| 855 | + EE_Error::overwrite_errors(); |
|
| 856 | + EE_Error::add_error(sprintf(__('This %1$s was saved without a title, description, or excerpt which means that none of the extra details you added were saved properly. All autodrafts will show up in the "draft" view of your event list table. You can delete them from there. Please click the "Add %1$s" button to refresh and restart.'), |
|
| 857 | + $label), __FILE__, __FUNCTION__, __LINE__); |
|
| 858 | + } |
|
| 859 | + } |
|
| 860 | + |
|
| 861 | + |
|
| 862 | + |
|
| 863 | + /** |
|
| 864 | + * admin_footer_scripts_global |
|
| 865 | + * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method |
|
| 866 | + * will apply on ALL EE_Admin pages. |
|
| 867 | + * |
|
| 868 | + * @access public |
|
| 869 | + * @return void |
|
| 870 | + */ |
|
| 871 | + public function admin_footer_scripts_global() |
|
| 872 | + { |
|
| 873 | + $this->_add_admin_page_ajax_loading_img(); |
|
| 874 | + $this->_add_admin_page_overlay(); |
|
| 875 | + } |
|
| 876 | + |
|
| 877 | + |
|
| 878 | + |
|
| 879 | + /** |
|
| 880 | + * add in any global scripts for cpt routes |
|
| 881 | + * |
|
| 882 | + * @return void |
|
| 883 | + */ |
|
| 884 | + public function load_global_scripts_styles() |
|
| 885 | + { |
|
| 886 | + parent::load_global_scripts_styles(); |
|
| 887 | + if ($this->_cpt_model_obj instanceof EE_CPT_Base) { |
|
| 888 | + //setup custom post status object for localize script but only if we've got a cpt object |
|
| 889 | + $statuses = $this->_cpt_model_obj->get_custom_post_statuses(); |
|
| 890 | + if ( ! empty($statuses)) { |
|
| 891 | + //get ALL statuses! |
|
| 892 | + $statuses = $this->_cpt_model_obj->get_all_post_statuses(); |
|
| 893 | + //setup object |
|
| 894 | + $ee_cpt_statuses = array(); |
|
| 895 | + foreach ($statuses as $status => $label) { |
|
| 896 | + $ee_cpt_statuses[$status] = array( |
|
| 897 | + 'label' => $label, |
|
| 898 | + 'save_label' => sprintf(__('Save as %s', 'event_espresso'), $label), |
|
| 899 | + ); |
|
| 900 | + } |
|
| 901 | + wp_localize_script('ee_admin_js', 'eeCPTstatuses', $ee_cpt_statuses); |
|
| 902 | + } |
|
| 903 | + } |
|
| 904 | + } |
|
| 905 | + |
|
| 906 | + |
|
| 907 | + |
|
| 908 | + /** |
|
| 909 | + * This is a wrapper for the insert/update routes for cpt items so we can add things that are common to ALL |
|
| 910 | + * insert/updates |
|
| 911 | + * |
|
| 912 | + * @param int $post_id ID of post being updated |
|
| 913 | + * @param WP_Post $post Post object from WP |
|
| 914 | + * @param bool $update Whether this is an update or a new save. |
|
| 915 | + * @return void |
|
| 916 | + * @throws \EE_Error |
|
| 917 | + */ |
|
| 918 | + public function insert_update($post_id, $post, $update) |
|
| 919 | + { |
|
| 920 | + //make sure that if this is a revision OR trash action that we don't do any updates! |
|
| 921 | + if ( |
|
| 922 | + isset($this->_req_data['action']) |
|
| 923 | + && ( |
|
| 924 | + $this->_req_data['action'] === 'restore' |
|
| 925 | + || $this->_req_data['action'] === 'trash' |
|
| 926 | + ) |
|
| 927 | + ) { |
|
| 928 | + return; |
|
| 929 | + } |
|
| 930 | + $this->_set_model_object($post_id, true, 'insert_update'); |
|
| 931 | + //if our cpt object is not instantiated and its NOT the same post_id as what is triggering this callback, then exit. |
|
| 932 | + if ($update |
|
| 933 | + && ( |
|
| 934 | + ! $this->_cpt_model_obj instanceof EE_CPT_Base |
|
| 935 | + || $this->_cpt_model_obj->ID() !== $post_id |
|
| 936 | + ) |
|
| 937 | + ) { |
|
| 938 | + return; |
|
| 939 | + } |
|
| 940 | + //check for autosave and update our req_data property accordingly. |
|
| 941 | + /*if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE && isset( $this->_req_data['ee_autosave_data'] ) ) { |
|
| 942 | 942 | foreach( (array) $this->_req_data['ee_autosave_data'] as $id => $values ) { |
| 943 | 943 | |
| 944 | 944 | foreach ( (array) $values as $key => $value ) { |
@@ -948,527 +948,527 @@ discard block |
||
| 948 | 948 | |
| 949 | 949 | }/**/ //TODO reactivate after autosave is implemented in 4.2 |
| 950 | 950 | |
| 951 | - //take care of updating any selected page_template IF this cpt supports it. |
|
| 952 | - if ($this->_supports_page_templates($post->post_type) && ! empty($this->_req_data['page_template'])) { |
|
| 953 | - //wp version aware. |
|
| 954 | - if (EE_Recommended_Versions::check_wp_version('4.7', '>=')) { |
|
| 955 | - $page_templates = wp_get_theme()->get_page_templates(); |
|
| 956 | - } else { |
|
| 957 | - $post->page_template = $this->_req_data['page_template']; |
|
| 958 | - $page_templates = wp_get_theme()->get_page_templates($post); |
|
| 959 | - } |
|
| 960 | - if ('default' != $this->_req_data['page_template'] && ! isset($page_templates[$this->_req_data['page_template']])) { |
|
| 961 | - EE_Error::add_error(__('Invalid Page Template.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
| 962 | - } else { |
|
| 963 | - update_post_meta($post_id, '_wp_page_template', $this->_req_data['page_template']); |
|
| 964 | - } |
|
| 965 | - } |
|
| 966 | - if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) { |
|
| 967 | - return; |
|
| 968 | - } //TODO we'll remove this after reimplementing autosave in 4.2 |
|
| 969 | - $this->_insert_update_cpt_item($post_id, $post); |
|
| 970 | - } |
|
| 971 | - |
|
| 972 | - |
|
| 973 | - |
|
| 974 | - /** |
|
| 975 | - * This hooks into the wp_trash_post() function and removes the `_wp_trash_meta_status` and `_wp_trash_meta_time` |
|
| 976 | - * post meta IF the trashed post is one of our CPT's - note this method should only be called with our cpt routes |
|
| 977 | - * so we don't have to check for our CPT. |
|
| 978 | - * |
|
| 979 | - * @param int $post_id ID of the post |
|
| 980 | - * @return void |
|
| 981 | - */ |
|
| 982 | - public function dont_permanently_delete_ee_cpts($post_id) |
|
| 983 | - { |
|
| 984 | - //only do this if we're actually processing one of our CPTs |
|
| 985 | - //if our cpt object isn't existent then get out immediately. |
|
| 986 | - if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) { |
|
| 987 | - return; |
|
| 988 | - } |
|
| 989 | - delete_post_meta($post_id, '_wp_trash_meta_status'); |
|
| 990 | - delete_post_meta($post_id, '_wp_trash_meta_time'); |
|
| 991 | - //our cpts may have comments so let's take care of that too |
|
| 992 | - delete_post_meta($post_id, '_wp_trash_meta_comments_status'); |
|
| 993 | - } |
|
| 994 | - |
|
| 995 | - |
|
| 996 | - |
|
| 997 | - /** |
|
| 998 | - * This is a wrapper for the restore_cpt_revision route for cpt items so we can make sure that when a revision is |
|
| 999 | - * triggered that we restore related items. In order to work cpt classes MUST have a restore_cpt_revision method |
|
| 1000 | - * in them. We also have our OWN action in here so addons can hook into the restore process easily. |
|
| 1001 | - * |
|
| 1002 | - * @param int $post_id ID of cpt item |
|
| 1003 | - * @param int $revision_id ID of revision being restored |
|
| 1004 | - * @return void |
|
| 1005 | - */ |
|
| 1006 | - public function restore_revision($post_id, $revision_id) |
|
| 1007 | - { |
|
| 1008 | - $this->_restore_cpt_item($post_id, $revision_id); |
|
| 1009 | - //global action |
|
| 1010 | - do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id); |
|
| 1011 | - //class specific action so you can limit hooking into a specific page. |
|
| 1012 | - do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id); |
|
| 1013 | - } |
|
| 1014 | - |
|
| 1015 | - |
|
| 1016 | - |
|
| 1017 | - /** |
|
| 1018 | - * @see restore_revision() for details |
|
| 1019 | - * @param int $post_id ID of cpt item |
|
| 1020 | - * @param int $revision_id ID of revision for item |
|
| 1021 | - * @return void |
|
| 1022 | - */ |
|
| 1023 | - abstract protected function _restore_cpt_item($post_id, $revision_id); |
|
| 1024 | - |
|
| 1025 | - |
|
| 1026 | - |
|
| 1027 | - /** |
|
| 1028 | - * Execution of this method is added to the end of the load_page_dependencies method in the parent |
|
| 1029 | - * so that we can fix a bug where default core metaboxes were not being called in the sidebar. |
|
| 1030 | - * To fix we have to reset the current_screen using the page_slug |
|
| 1031 | - * (which is identical - or should be - to our registered_post_type id.) |
|
| 1032 | - * Also, since the core WP file loads the admin_header.php for WP |
|
| 1033 | - * (and there are a bunch of other things edit-form-advanced.php loads that need to happen really early) |
|
| 1034 | - * we need to load it NOW, hence our _route_admin_request in here. (Otherwise screen options won't be set). |
|
| 1035 | - * |
|
| 1036 | - * @return void |
|
| 1037 | - */ |
|
| 1038 | - public function modify_current_screen() |
|
| 1039 | - { |
|
| 1040 | - //ONLY do this if the current page_route IS a cpt route |
|
| 1041 | - if ( ! $this->_cpt_route) { |
|
| 1042 | - return; |
|
| 1043 | - } |
|
| 1044 | - //routing things REALLY early b/c this is a cpt admin page |
|
| 1045 | - set_current_screen($this->_cpt_routes[$this->_req_action]); |
|
| 1046 | - $this->_current_screen = get_current_screen(); |
|
| 1047 | - $this->_current_screen->base = 'event-espresso'; |
|
| 1048 | - $this->_add_help_tabs(); //we make sure we add any help tabs back in! |
|
| 1049 | - /*try { |
|
| 951 | + //take care of updating any selected page_template IF this cpt supports it. |
|
| 952 | + if ($this->_supports_page_templates($post->post_type) && ! empty($this->_req_data['page_template'])) { |
|
| 953 | + //wp version aware. |
|
| 954 | + if (EE_Recommended_Versions::check_wp_version('4.7', '>=')) { |
|
| 955 | + $page_templates = wp_get_theme()->get_page_templates(); |
|
| 956 | + } else { |
|
| 957 | + $post->page_template = $this->_req_data['page_template']; |
|
| 958 | + $page_templates = wp_get_theme()->get_page_templates($post); |
|
| 959 | + } |
|
| 960 | + if ('default' != $this->_req_data['page_template'] && ! isset($page_templates[$this->_req_data['page_template']])) { |
|
| 961 | + EE_Error::add_error(__('Invalid Page Template.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
| 962 | + } else { |
|
| 963 | + update_post_meta($post_id, '_wp_page_template', $this->_req_data['page_template']); |
|
| 964 | + } |
|
| 965 | + } |
|
| 966 | + if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) { |
|
| 967 | + return; |
|
| 968 | + } //TODO we'll remove this after reimplementing autosave in 4.2 |
|
| 969 | + $this->_insert_update_cpt_item($post_id, $post); |
|
| 970 | + } |
|
| 971 | + |
|
| 972 | + |
|
| 973 | + |
|
| 974 | + /** |
|
| 975 | + * This hooks into the wp_trash_post() function and removes the `_wp_trash_meta_status` and `_wp_trash_meta_time` |
|
| 976 | + * post meta IF the trashed post is one of our CPT's - note this method should only be called with our cpt routes |
|
| 977 | + * so we don't have to check for our CPT. |
|
| 978 | + * |
|
| 979 | + * @param int $post_id ID of the post |
|
| 980 | + * @return void |
|
| 981 | + */ |
|
| 982 | + public function dont_permanently_delete_ee_cpts($post_id) |
|
| 983 | + { |
|
| 984 | + //only do this if we're actually processing one of our CPTs |
|
| 985 | + //if our cpt object isn't existent then get out immediately. |
|
| 986 | + if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) { |
|
| 987 | + return; |
|
| 988 | + } |
|
| 989 | + delete_post_meta($post_id, '_wp_trash_meta_status'); |
|
| 990 | + delete_post_meta($post_id, '_wp_trash_meta_time'); |
|
| 991 | + //our cpts may have comments so let's take care of that too |
|
| 992 | + delete_post_meta($post_id, '_wp_trash_meta_comments_status'); |
|
| 993 | + } |
|
| 994 | + |
|
| 995 | + |
|
| 996 | + |
|
| 997 | + /** |
|
| 998 | + * This is a wrapper for the restore_cpt_revision route for cpt items so we can make sure that when a revision is |
|
| 999 | + * triggered that we restore related items. In order to work cpt classes MUST have a restore_cpt_revision method |
|
| 1000 | + * in them. We also have our OWN action in here so addons can hook into the restore process easily. |
|
| 1001 | + * |
|
| 1002 | + * @param int $post_id ID of cpt item |
|
| 1003 | + * @param int $revision_id ID of revision being restored |
|
| 1004 | + * @return void |
|
| 1005 | + */ |
|
| 1006 | + public function restore_revision($post_id, $revision_id) |
|
| 1007 | + { |
|
| 1008 | + $this->_restore_cpt_item($post_id, $revision_id); |
|
| 1009 | + //global action |
|
| 1010 | + do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id); |
|
| 1011 | + //class specific action so you can limit hooking into a specific page. |
|
| 1012 | + do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id); |
|
| 1013 | + } |
|
| 1014 | + |
|
| 1015 | + |
|
| 1016 | + |
|
| 1017 | + /** |
|
| 1018 | + * @see restore_revision() for details |
|
| 1019 | + * @param int $post_id ID of cpt item |
|
| 1020 | + * @param int $revision_id ID of revision for item |
|
| 1021 | + * @return void |
|
| 1022 | + */ |
|
| 1023 | + abstract protected function _restore_cpt_item($post_id, $revision_id); |
|
| 1024 | + |
|
| 1025 | + |
|
| 1026 | + |
|
| 1027 | + /** |
|
| 1028 | + * Execution of this method is added to the end of the load_page_dependencies method in the parent |
|
| 1029 | + * so that we can fix a bug where default core metaboxes were not being called in the sidebar. |
|
| 1030 | + * To fix we have to reset the current_screen using the page_slug |
|
| 1031 | + * (which is identical - or should be - to our registered_post_type id.) |
|
| 1032 | + * Also, since the core WP file loads the admin_header.php for WP |
|
| 1033 | + * (and there are a bunch of other things edit-form-advanced.php loads that need to happen really early) |
|
| 1034 | + * we need to load it NOW, hence our _route_admin_request in here. (Otherwise screen options won't be set). |
|
| 1035 | + * |
|
| 1036 | + * @return void |
|
| 1037 | + */ |
|
| 1038 | + public function modify_current_screen() |
|
| 1039 | + { |
|
| 1040 | + //ONLY do this if the current page_route IS a cpt route |
|
| 1041 | + if ( ! $this->_cpt_route) { |
|
| 1042 | + return; |
|
| 1043 | + } |
|
| 1044 | + //routing things REALLY early b/c this is a cpt admin page |
|
| 1045 | + set_current_screen($this->_cpt_routes[$this->_req_action]); |
|
| 1046 | + $this->_current_screen = get_current_screen(); |
|
| 1047 | + $this->_current_screen->base = 'event-espresso'; |
|
| 1048 | + $this->_add_help_tabs(); //we make sure we add any help tabs back in! |
|
| 1049 | + /*try { |
|
| 1050 | 1050 | $this->_route_admin_request(); |
| 1051 | 1051 | } catch ( EE_Error $e ) { |
| 1052 | 1052 | $e->get_error(); |
| 1053 | 1053 | }/**/ |
| 1054 | - } |
|
| 1055 | - |
|
| 1056 | - |
|
| 1057 | - |
|
| 1058 | - /** |
|
| 1059 | - * This allows child classes to modify the default editor title that appears when people add a new or edit an |
|
| 1060 | - * existing CPT item. * This uses the _labels property set by the child class via _define_page_props. Just make |
|
| 1061 | - * sure you have a key in _labels property that equals 'editor_title' and the value can be whatever you want the |
|
| 1062 | - * default to be. |
|
| 1063 | - * |
|
| 1064 | - * @param string $title The new title (or existing if there is no editor_title defined) |
|
| 1065 | - * @return string |
|
| 1066 | - */ |
|
| 1067 | - public function add_custom_editor_default_title($title) |
|
| 1068 | - { |
|
| 1069 | - return isset($this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]]) |
|
| 1070 | - ? $this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]] |
|
| 1071 | - : $title; |
|
| 1072 | - } |
|
| 1073 | - |
|
| 1074 | - |
|
| 1075 | - |
|
| 1076 | - /** |
|
| 1077 | - * hooks into the wp_get_shortlink button and makes sure that the shortlink gets generated |
|
| 1078 | - * |
|
| 1079 | - * @param string $shortlink The already generated shortlink |
|
| 1080 | - * @param int $id Post ID for this item |
|
| 1081 | - * @param string $context The context for the link |
|
| 1082 | - * @param bool $allow_slugs Whether to allow post slugs in the shortlink. |
|
| 1083 | - * @return string |
|
| 1084 | - */ |
|
| 1085 | - public function add_shortlink_button_to_editor($shortlink, $id, $context, $allow_slugs) |
|
| 1086 | - { |
|
| 1087 | - if ( ! empty($id) && get_option('permalink_structure') !== '') { |
|
| 1088 | - $post = get_post($id); |
|
| 1089 | - if (isset($post->post_type) && $this->page_slug === $post->post_type) { |
|
| 1090 | - $shortlink = home_url('?p=' . $post->ID); |
|
| 1091 | - } |
|
| 1092 | - } |
|
| 1093 | - return $shortlink; |
|
| 1094 | - } |
|
| 1095 | - |
|
| 1096 | - |
|
| 1097 | - |
|
| 1098 | - /** |
|
| 1099 | - * overriding the parent route_admin_request method so we DON'T run the route twice on cpt core page loads (it's |
|
| 1100 | - * already run in modify_current_screen()) |
|
| 1101 | - * |
|
| 1102 | - * @return void |
|
| 1103 | - */ |
|
| 1104 | - public function route_admin_request() |
|
| 1105 | - { |
|
| 1106 | - if ($this->_cpt_route) { |
|
| 1107 | - return; |
|
| 1108 | - } |
|
| 1109 | - try { |
|
| 1110 | - $this->_route_admin_request(); |
|
| 1111 | - } catch (EE_Error $e) { |
|
| 1112 | - $e->get_error(); |
|
| 1113 | - } |
|
| 1114 | - } |
|
| 1115 | - |
|
| 1116 | - |
|
| 1117 | - |
|
| 1118 | - /** |
|
| 1119 | - * Add a hidden form input to cpt core pages so that we know to do redirects to our routes on saves |
|
| 1120 | - * |
|
| 1121 | - * @return void |
|
| 1122 | - */ |
|
| 1123 | - public function cpt_post_form_hidden_input() |
|
| 1124 | - { |
|
| 1125 | - echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="' . $this->_admin_base_url . '" />'; |
|
| 1126 | - //we're also going to add the route value and the current page so we can direct autosave parsing correctly |
|
| 1127 | - echo '<div id="ee-cpt-hidden-inputs">'; |
|
| 1128 | - echo '<input type="hidden" id="current_route" name="current_route" value="' . $this->_current_view . '" />'; |
|
| 1129 | - echo '<input type="hidden" id="current_page" name="current_page" value="' . $this->page_slug . '" />'; |
|
| 1130 | - echo '</div>'; |
|
| 1131 | - } |
|
| 1132 | - |
|
| 1133 | - |
|
| 1134 | - |
|
| 1135 | - /** |
|
| 1136 | - * This allows us to redirect the location of revision restores when they happen so it goes to our CPT routes. |
|
| 1137 | - * |
|
| 1138 | - * @param string $location Original location url |
|
| 1139 | - * @param int $status Status for http header |
|
| 1140 | - * @return string new (or original) url to redirect to. |
|
| 1141 | - */ |
|
| 1142 | - public function revision_redirect($location, $status) |
|
| 1143 | - { |
|
| 1144 | - //get revision |
|
| 1145 | - $rev_id = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null; |
|
| 1146 | - //can't do anything without revision so let's get out if not present |
|
| 1147 | - if (empty($rev_id)) { |
|
| 1148 | - return $location; |
|
| 1149 | - } |
|
| 1150 | - //get rev_post_data |
|
| 1151 | - $rev = get_post($rev_id); |
|
| 1152 | - $admin_url = $this->_admin_base_url; |
|
| 1153 | - $query_args = array( |
|
| 1154 | - 'action' => 'edit', |
|
| 1155 | - 'post' => $rev->post_parent, |
|
| 1156 | - 'revision' => $rev_id, |
|
| 1157 | - 'message' => 5, |
|
| 1158 | - ); |
|
| 1159 | - $this->_process_notices($query_args, true); |
|
| 1160 | - return self::add_query_args_and_nonce($query_args, $admin_url); |
|
| 1161 | - } |
|
| 1162 | - |
|
| 1163 | - |
|
| 1164 | - |
|
| 1165 | - /** |
|
| 1166 | - * Modify the edit post link generated by wp core function so that EE CPTs get setup differently. |
|
| 1167 | - * |
|
| 1168 | - * @param string $link the original generated link |
|
| 1169 | - * @param int $id post id |
|
| 1170 | - * @param string $context optional, defaults to display. How to write the '&' |
|
| 1171 | - * @return string the link |
|
| 1172 | - */ |
|
| 1173 | - public function modify_edit_post_link($link, $id, $context) |
|
| 1174 | - { |
|
| 1175 | - $post = get_post($id); |
|
| 1176 | - if ( ! isset($this->_req_data['action']) |
|
| 1177 | - || ! isset($this->_cpt_routes[$this->_req_data['action']]) |
|
| 1178 | - || $post->post_type !== $this->_cpt_routes[$this->_req_data['action']] |
|
| 1179 | - ) { |
|
| 1180 | - return $link; |
|
| 1181 | - } |
|
| 1182 | - $query_args = array( |
|
| 1183 | - 'action' => isset($this->_cpt_edit_routes[$post->post_type]) |
|
| 1184 | - ? $this->_cpt_edit_routes[$post->post_type] |
|
| 1185 | - : 'edit', |
|
| 1186 | - 'post' => $id, |
|
| 1187 | - ); |
|
| 1188 | - return self::add_query_args_and_nonce($query_args, $this->_admin_base_url); |
|
| 1189 | - } |
|
| 1190 | - |
|
| 1191 | - |
|
| 1192 | - /** |
|
| 1193 | - * Modify the trash link on our cpt edit pages so it has the required query var for triggering redirect properly on |
|
| 1194 | - * our routes. |
|
| 1195 | - * |
|
| 1196 | - * @param string $delete_link original delete link |
|
| 1197 | - * @param int $post_id id of cpt object |
|
| 1198 | - * @param bool $force_delete whether this is forcing a hard delete instead of trash |
|
| 1199 | - * @return string new delete link |
|
| 1200 | - * @throws EE_Error |
|
| 1201 | - */ |
|
| 1202 | - public function modify_delete_post_link($delete_link, $post_id, $force_delete) |
|
| 1203 | - { |
|
| 1204 | - $post = get_post($post_id); |
|
| 1205 | - |
|
| 1206 | - if (empty($this->_req_data['action']) |
|
| 1207 | - || ! isset($this->_cpt_routes[$this->_req_data['action']]) |
|
| 1208 | - || ! $post instanceof WP_Post |
|
| 1209 | - || $post->post_type !== $this->_cpt_routes[$this->_req_data['action']] |
|
| 1210 | - ) { |
|
| 1211 | - return $delete_link; |
|
| 1212 | - } |
|
| 1213 | - $this->_set_model_object($post->ID, true); |
|
| 1214 | - |
|
| 1215 | - //returns something like `trash_event` or `trash_attendee` or `trash_venue` |
|
| 1216 | - $action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj))); |
|
| 1217 | - |
|
| 1218 | - return EE_Admin_Page::add_query_args_and_nonce( |
|
| 1219 | - array( |
|
| 1220 | - 'page' => $this->_req_data['page'], |
|
| 1221 | - 'action' => $action, |
|
| 1222 | - $this->_cpt_model_obj->get_model()->get_primary_key_field()->get_name() |
|
| 1223 | - => $post->ID |
|
| 1224 | - ), |
|
| 1225 | - admin_url() |
|
| 1226 | - ); |
|
| 1227 | - } |
|
| 1228 | - |
|
| 1229 | - |
|
| 1230 | - |
|
| 1231 | - /** |
|
| 1232 | - * This is the callback for the 'redirect_post_location' filter in wp-admin/post.php |
|
| 1233 | - * so that we can hijack the default redirect locations for wp custom post types |
|
| 1234 | - * that WE'RE using and send back to OUR routes. This should only be hooked in on the right route. |
|
| 1235 | - * |
|
| 1236 | - * @param string $location This is the incoming currently set redirect location |
|
| 1237 | - * @param string $post_id This is the 'ID' value of the wp_posts table |
|
| 1238 | - * @return string the new location to redirect to |
|
| 1239 | - */ |
|
| 1240 | - public function cpt_post_location_redirect($location, $post_id) |
|
| 1241 | - { |
|
| 1242 | - //we DO have a match so let's setup the url |
|
| 1243 | - //we have to get the post to determine our route |
|
| 1244 | - $post = get_post($post_id); |
|
| 1245 | - $edit_route = $this->_cpt_edit_routes[$post->post_type]; |
|
| 1246 | - //shared query_args |
|
| 1247 | - $query_args = array('action' => $edit_route, 'post' => $post_id); |
|
| 1248 | - $admin_url = $this->_admin_base_url; |
|
| 1249 | - if (isset($this->_req_data['save']) || isset($this->_req_data['publish'])) { |
|
| 1250 | - $status = get_post_status($post_id); |
|
| 1251 | - if (isset($this->_req_data['publish'])) { |
|
| 1252 | - switch ($status) { |
|
| 1253 | - case 'pending': |
|
| 1254 | - $message = 8; |
|
| 1255 | - break; |
|
| 1256 | - case 'future': |
|
| 1257 | - $message = 9; |
|
| 1258 | - break; |
|
| 1259 | - default: |
|
| 1260 | - $message = 6; |
|
| 1261 | - } |
|
| 1262 | - } else { |
|
| 1263 | - $message = 'draft' === $status ? 10 : 1; |
|
| 1264 | - } |
|
| 1265 | - } else if (isset($this->_req_data['addmeta']) && $this->_req_data['addmeta']) { |
|
| 1266 | - $message = 2; |
|
| 1267 | - // $append = '#postcustom'; |
|
| 1268 | - } else if (isset($this->_req_data['deletemeta']) && $this->_req_data['deletemeta']) { |
|
| 1269 | - $message = 3; |
|
| 1270 | - // $append = '#postcustom'; |
|
| 1271 | - } elseif ($this->_req_data['action'] === 'post-quickpress-save-cont') { |
|
| 1272 | - $message = 7; |
|
| 1273 | - } else { |
|
| 1274 | - $message = 4; |
|
| 1275 | - } |
|
| 1276 | - //change the message if the post type is not viewable on the frontend |
|
| 1277 | - $this->_cpt_object = get_post_type_object($post->post_type); |
|
| 1278 | - $message = $message === 1 && ! $this->_cpt_object->publicly_queryable ? 4 : $message; |
|
| 1279 | - $query_args = array_merge(array('message' => $message), $query_args); |
|
| 1280 | - $this->_process_notices($query_args, true); |
|
| 1281 | - return self::add_query_args_and_nonce($query_args, $admin_url); |
|
| 1282 | - } |
|
| 1283 | - |
|
| 1284 | - |
|
| 1285 | - |
|
| 1286 | - /** |
|
| 1287 | - * This method is called to inject nav tabs on core WP cpt pages |
|
| 1288 | - * |
|
| 1289 | - * @access public |
|
| 1290 | - * @return void |
|
| 1291 | - */ |
|
| 1292 | - public function inject_nav_tabs() |
|
| 1293 | - { |
|
| 1294 | - //can we hijack and insert the nav_tabs? |
|
| 1295 | - $nav_tabs = $this->_get_main_nav_tabs(); |
|
| 1296 | - //first close off existing form tag |
|
| 1297 | - $html = '>'; |
|
| 1298 | - $html .= $nav_tabs; |
|
| 1299 | - //now let's handle the remaining tag ( missing ">" is CORRECT ) |
|
| 1300 | - $html .= '<span></span'; |
|
| 1301 | - echo $html; |
|
| 1302 | - } |
|
| 1303 | - |
|
| 1304 | - |
|
| 1305 | - |
|
| 1306 | - /** |
|
| 1307 | - * This just sets up the post update messages when an update form is loaded |
|
| 1308 | - * |
|
| 1309 | - * @access public |
|
| 1310 | - * @param array $messages the original messages array |
|
| 1311 | - * @return array the new messages array |
|
| 1312 | - */ |
|
| 1313 | - public function post_update_messages($messages) |
|
| 1314 | - { |
|
| 1315 | - global $post; |
|
| 1316 | - $id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null; |
|
| 1317 | - $id = empty($id) && is_object($post) ? $post->ID : null; |
|
| 1318 | - // $post_type = $post ? $post->post_type : false; |
|
| 1319 | - /*$current_route = isset($this->_req_data['current_route']) ? $this->_req_data['current_route'] : 'shouldneverwork'; |
|
| 1054 | + } |
|
| 1055 | + |
|
| 1056 | + |
|
| 1057 | + |
|
| 1058 | + /** |
|
| 1059 | + * This allows child classes to modify the default editor title that appears when people add a new or edit an |
|
| 1060 | + * existing CPT item. * This uses the _labels property set by the child class via _define_page_props. Just make |
|
| 1061 | + * sure you have a key in _labels property that equals 'editor_title' and the value can be whatever you want the |
|
| 1062 | + * default to be. |
|
| 1063 | + * |
|
| 1064 | + * @param string $title The new title (or existing if there is no editor_title defined) |
|
| 1065 | + * @return string |
|
| 1066 | + */ |
|
| 1067 | + public function add_custom_editor_default_title($title) |
|
| 1068 | + { |
|
| 1069 | + return isset($this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]]) |
|
| 1070 | + ? $this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]] |
|
| 1071 | + : $title; |
|
| 1072 | + } |
|
| 1073 | + |
|
| 1074 | + |
|
| 1075 | + |
|
| 1076 | + /** |
|
| 1077 | + * hooks into the wp_get_shortlink button and makes sure that the shortlink gets generated |
|
| 1078 | + * |
|
| 1079 | + * @param string $shortlink The already generated shortlink |
|
| 1080 | + * @param int $id Post ID for this item |
|
| 1081 | + * @param string $context The context for the link |
|
| 1082 | + * @param bool $allow_slugs Whether to allow post slugs in the shortlink. |
|
| 1083 | + * @return string |
|
| 1084 | + */ |
|
| 1085 | + public function add_shortlink_button_to_editor($shortlink, $id, $context, $allow_slugs) |
|
| 1086 | + { |
|
| 1087 | + if ( ! empty($id) && get_option('permalink_structure') !== '') { |
|
| 1088 | + $post = get_post($id); |
|
| 1089 | + if (isset($post->post_type) && $this->page_slug === $post->post_type) { |
|
| 1090 | + $shortlink = home_url('?p=' . $post->ID); |
|
| 1091 | + } |
|
| 1092 | + } |
|
| 1093 | + return $shortlink; |
|
| 1094 | + } |
|
| 1095 | + |
|
| 1096 | + |
|
| 1097 | + |
|
| 1098 | + /** |
|
| 1099 | + * overriding the parent route_admin_request method so we DON'T run the route twice on cpt core page loads (it's |
|
| 1100 | + * already run in modify_current_screen()) |
|
| 1101 | + * |
|
| 1102 | + * @return void |
|
| 1103 | + */ |
|
| 1104 | + public function route_admin_request() |
|
| 1105 | + { |
|
| 1106 | + if ($this->_cpt_route) { |
|
| 1107 | + return; |
|
| 1108 | + } |
|
| 1109 | + try { |
|
| 1110 | + $this->_route_admin_request(); |
|
| 1111 | + } catch (EE_Error $e) { |
|
| 1112 | + $e->get_error(); |
|
| 1113 | + } |
|
| 1114 | + } |
|
| 1115 | + |
|
| 1116 | + |
|
| 1117 | + |
|
| 1118 | + /** |
|
| 1119 | + * Add a hidden form input to cpt core pages so that we know to do redirects to our routes on saves |
|
| 1120 | + * |
|
| 1121 | + * @return void |
|
| 1122 | + */ |
|
| 1123 | + public function cpt_post_form_hidden_input() |
|
| 1124 | + { |
|
| 1125 | + echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="' . $this->_admin_base_url . '" />'; |
|
| 1126 | + //we're also going to add the route value and the current page so we can direct autosave parsing correctly |
|
| 1127 | + echo '<div id="ee-cpt-hidden-inputs">'; |
|
| 1128 | + echo '<input type="hidden" id="current_route" name="current_route" value="' . $this->_current_view . '" />'; |
|
| 1129 | + echo '<input type="hidden" id="current_page" name="current_page" value="' . $this->page_slug . '" />'; |
|
| 1130 | + echo '</div>'; |
|
| 1131 | + } |
|
| 1132 | + |
|
| 1133 | + |
|
| 1134 | + |
|
| 1135 | + /** |
|
| 1136 | + * This allows us to redirect the location of revision restores when they happen so it goes to our CPT routes. |
|
| 1137 | + * |
|
| 1138 | + * @param string $location Original location url |
|
| 1139 | + * @param int $status Status for http header |
|
| 1140 | + * @return string new (or original) url to redirect to. |
|
| 1141 | + */ |
|
| 1142 | + public function revision_redirect($location, $status) |
|
| 1143 | + { |
|
| 1144 | + //get revision |
|
| 1145 | + $rev_id = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null; |
|
| 1146 | + //can't do anything without revision so let's get out if not present |
|
| 1147 | + if (empty($rev_id)) { |
|
| 1148 | + return $location; |
|
| 1149 | + } |
|
| 1150 | + //get rev_post_data |
|
| 1151 | + $rev = get_post($rev_id); |
|
| 1152 | + $admin_url = $this->_admin_base_url; |
|
| 1153 | + $query_args = array( |
|
| 1154 | + 'action' => 'edit', |
|
| 1155 | + 'post' => $rev->post_parent, |
|
| 1156 | + 'revision' => $rev_id, |
|
| 1157 | + 'message' => 5, |
|
| 1158 | + ); |
|
| 1159 | + $this->_process_notices($query_args, true); |
|
| 1160 | + return self::add_query_args_and_nonce($query_args, $admin_url); |
|
| 1161 | + } |
|
| 1162 | + |
|
| 1163 | + |
|
| 1164 | + |
|
| 1165 | + /** |
|
| 1166 | + * Modify the edit post link generated by wp core function so that EE CPTs get setup differently. |
|
| 1167 | + * |
|
| 1168 | + * @param string $link the original generated link |
|
| 1169 | + * @param int $id post id |
|
| 1170 | + * @param string $context optional, defaults to display. How to write the '&' |
|
| 1171 | + * @return string the link |
|
| 1172 | + */ |
|
| 1173 | + public function modify_edit_post_link($link, $id, $context) |
|
| 1174 | + { |
|
| 1175 | + $post = get_post($id); |
|
| 1176 | + if ( ! isset($this->_req_data['action']) |
|
| 1177 | + || ! isset($this->_cpt_routes[$this->_req_data['action']]) |
|
| 1178 | + || $post->post_type !== $this->_cpt_routes[$this->_req_data['action']] |
|
| 1179 | + ) { |
|
| 1180 | + return $link; |
|
| 1181 | + } |
|
| 1182 | + $query_args = array( |
|
| 1183 | + 'action' => isset($this->_cpt_edit_routes[$post->post_type]) |
|
| 1184 | + ? $this->_cpt_edit_routes[$post->post_type] |
|
| 1185 | + : 'edit', |
|
| 1186 | + 'post' => $id, |
|
| 1187 | + ); |
|
| 1188 | + return self::add_query_args_and_nonce($query_args, $this->_admin_base_url); |
|
| 1189 | + } |
|
| 1190 | + |
|
| 1191 | + |
|
| 1192 | + /** |
|
| 1193 | + * Modify the trash link on our cpt edit pages so it has the required query var for triggering redirect properly on |
|
| 1194 | + * our routes. |
|
| 1195 | + * |
|
| 1196 | + * @param string $delete_link original delete link |
|
| 1197 | + * @param int $post_id id of cpt object |
|
| 1198 | + * @param bool $force_delete whether this is forcing a hard delete instead of trash |
|
| 1199 | + * @return string new delete link |
|
| 1200 | + * @throws EE_Error |
|
| 1201 | + */ |
|
| 1202 | + public function modify_delete_post_link($delete_link, $post_id, $force_delete) |
|
| 1203 | + { |
|
| 1204 | + $post = get_post($post_id); |
|
| 1205 | + |
|
| 1206 | + if (empty($this->_req_data['action']) |
|
| 1207 | + || ! isset($this->_cpt_routes[$this->_req_data['action']]) |
|
| 1208 | + || ! $post instanceof WP_Post |
|
| 1209 | + || $post->post_type !== $this->_cpt_routes[$this->_req_data['action']] |
|
| 1210 | + ) { |
|
| 1211 | + return $delete_link; |
|
| 1212 | + } |
|
| 1213 | + $this->_set_model_object($post->ID, true); |
|
| 1214 | + |
|
| 1215 | + //returns something like `trash_event` or `trash_attendee` or `trash_venue` |
|
| 1216 | + $action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj))); |
|
| 1217 | + |
|
| 1218 | + return EE_Admin_Page::add_query_args_and_nonce( |
|
| 1219 | + array( |
|
| 1220 | + 'page' => $this->_req_data['page'], |
|
| 1221 | + 'action' => $action, |
|
| 1222 | + $this->_cpt_model_obj->get_model()->get_primary_key_field()->get_name() |
|
| 1223 | + => $post->ID |
|
| 1224 | + ), |
|
| 1225 | + admin_url() |
|
| 1226 | + ); |
|
| 1227 | + } |
|
| 1228 | + |
|
| 1229 | + |
|
| 1230 | + |
|
| 1231 | + /** |
|
| 1232 | + * This is the callback for the 'redirect_post_location' filter in wp-admin/post.php |
|
| 1233 | + * so that we can hijack the default redirect locations for wp custom post types |
|
| 1234 | + * that WE'RE using and send back to OUR routes. This should only be hooked in on the right route. |
|
| 1235 | + * |
|
| 1236 | + * @param string $location This is the incoming currently set redirect location |
|
| 1237 | + * @param string $post_id This is the 'ID' value of the wp_posts table |
|
| 1238 | + * @return string the new location to redirect to |
|
| 1239 | + */ |
|
| 1240 | + public function cpt_post_location_redirect($location, $post_id) |
|
| 1241 | + { |
|
| 1242 | + //we DO have a match so let's setup the url |
|
| 1243 | + //we have to get the post to determine our route |
|
| 1244 | + $post = get_post($post_id); |
|
| 1245 | + $edit_route = $this->_cpt_edit_routes[$post->post_type]; |
|
| 1246 | + //shared query_args |
|
| 1247 | + $query_args = array('action' => $edit_route, 'post' => $post_id); |
|
| 1248 | + $admin_url = $this->_admin_base_url; |
|
| 1249 | + if (isset($this->_req_data['save']) || isset($this->_req_data['publish'])) { |
|
| 1250 | + $status = get_post_status($post_id); |
|
| 1251 | + if (isset($this->_req_data['publish'])) { |
|
| 1252 | + switch ($status) { |
|
| 1253 | + case 'pending': |
|
| 1254 | + $message = 8; |
|
| 1255 | + break; |
|
| 1256 | + case 'future': |
|
| 1257 | + $message = 9; |
|
| 1258 | + break; |
|
| 1259 | + default: |
|
| 1260 | + $message = 6; |
|
| 1261 | + } |
|
| 1262 | + } else { |
|
| 1263 | + $message = 'draft' === $status ? 10 : 1; |
|
| 1264 | + } |
|
| 1265 | + } else if (isset($this->_req_data['addmeta']) && $this->_req_data['addmeta']) { |
|
| 1266 | + $message = 2; |
|
| 1267 | + // $append = '#postcustom'; |
|
| 1268 | + } else if (isset($this->_req_data['deletemeta']) && $this->_req_data['deletemeta']) { |
|
| 1269 | + $message = 3; |
|
| 1270 | + // $append = '#postcustom'; |
|
| 1271 | + } elseif ($this->_req_data['action'] === 'post-quickpress-save-cont') { |
|
| 1272 | + $message = 7; |
|
| 1273 | + } else { |
|
| 1274 | + $message = 4; |
|
| 1275 | + } |
|
| 1276 | + //change the message if the post type is not viewable on the frontend |
|
| 1277 | + $this->_cpt_object = get_post_type_object($post->post_type); |
|
| 1278 | + $message = $message === 1 && ! $this->_cpt_object->publicly_queryable ? 4 : $message; |
|
| 1279 | + $query_args = array_merge(array('message' => $message), $query_args); |
|
| 1280 | + $this->_process_notices($query_args, true); |
|
| 1281 | + return self::add_query_args_and_nonce($query_args, $admin_url); |
|
| 1282 | + } |
|
| 1283 | + |
|
| 1284 | + |
|
| 1285 | + |
|
| 1286 | + /** |
|
| 1287 | + * This method is called to inject nav tabs on core WP cpt pages |
|
| 1288 | + * |
|
| 1289 | + * @access public |
|
| 1290 | + * @return void |
|
| 1291 | + */ |
|
| 1292 | + public function inject_nav_tabs() |
|
| 1293 | + { |
|
| 1294 | + //can we hijack and insert the nav_tabs? |
|
| 1295 | + $nav_tabs = $this->_get_main_nav_tabs(); |
|
| 1296 | + //first close off existing form tag |
|
| 1297 | + $html = '>'; |
|
| 1298 | + $html .= $nav_tabs; |
|
| 1299 | + //now let's handle the remaining tag ( missing ">" is CORRECT ) |
|
| 1300 | + $html .= '<span></span'; |
|
| 1301 | + echo $html; |
|
| 1302 | + } |
|
| 1303 | + |
|
| 1304 | + |
|
| 1305 | + |
|
| 1306 | + /** |
|
| 1307 | + * This just sets up the post update messages when an update form is loaded |
|
| 1308 | + * |
|
| 1309 | + * @access public |
|
| 1310 | + * @param array $messages the original messages array |
|
| 1311 | + * @return array the new messages array |
|
| 1312 | + */ |
|
| 1313 | + public function post_update_messages($messages) |
|
| 1314 | + { |
|
| 1315 | + global $post; |
|
| 1316 | + $id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null; |
|
| 1317 | + $id = empty($id) && is_object($post) ? $post->ID : null; |
|
| 1318 | + // $post_type = $post ? $post->post_type : false; |
|
| 1319 | + /*$current_route = isset($this->_req_data['current_route']) ? $this->_req_data['current_route'] : 'shouldneverwork'; |
|
| 1320 | 1320 | |
| 1321 | 1321 | $route_to_check = $post_type && isset( $this->_cpt_routes[$current_route]) ? $this->_cpt_routes[$current_route] : '';/**/ |
| 1322 | - $messages[$post->post_type] = array( |
|
| 1323 | - 0 => '', //Unused. Messages start at index 1. |
|
| 1324 | - 1 => sprintf( |
|
| 1325 | - __('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'), |
|
| 1326 | - $this->_cpt_object->labels->singular_name, |
|
| 1327 | - '<a href="' . esc_url(get_permalink($id)) . '">', |
|
| 1328 | - '</a>' |
|
| 1329 | - ), |
|
| 1330 | - 2 => __('Custom field updated'), |
|
| 1331 | - 3 => __('Custom field deleted.'), |
|
| 1332 | - 4 => sprintf(__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name), |
|
| 1333 | - 5 => isset($_GET['revision']) ? sprintf(__('%s restored to revision from %s', 'event_espresso'), |
|
| 1334 | - $this->_cpt_object->labels->singular_name, wp_post_revision_title((int)$_GET['revision'], false)) |
|
| 1335 | - : false, |
|
| 1336 | - 6 => sprintf( |
|
| 1337 | - __('%1$s published. %2$sView %1$s%3$s', 'event_espresso'), |
|
| 1338 | - $this->_cpt_object->labels->singular_name, |
|
| 1339 | - '<a href="' . esc_url(get_permalink($id)) . '">', |
|
| 1340 | - '</a>' |
|
| 1341 | - ), |
|
| 1342 | - 7 => sprintf(__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name), |
|
| 1343 | - 8 => sprintf( |
|
| 1344 | - __('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'), |
|
| 1345 | - $this->_cpt_object->labels->singular_name, |
|
| 1346 | - '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">', |
|
| 1347 | - '</a>' |
|
| 1348 | - ), |
|
| 1349 | - 9 => sprintf( |
|
| 1350 | - __('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'), |
|
| 1351 | - $this->_cpt_object->labels->singular_name, |
|
| 1352 | - '<strong>' . date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)) . '</strong>', |
|
| 1353 | - '<a target="_blank" href="' . esc_url(get_permalink($id)), |
|
| 1354 | - '</a>' |
|
| 1355 | - ), |
|
| 1356 | - 10 => sprintf( |
|
| 1357 | - __('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'), |
|
| 1358 | - $this->_cpt_object->labels->singular_name, |
|
| 1359 | - '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))), |
|
| 1360 | - '</a>' |
|
| 1361 | - ), |
|
| 1362 | - ); |
|
| 1363 | - return $messages; |
|
| 1364 | - } |
|
| 1365 | - |
|
| 1366 | - |
|
| 1367 | - |
|
| 1368 | - /** |
|
| 1369 | - * default method for the 'create_new' route for cpt admin pages. |
|
| 1370 | - * For reference what to include in here, see wp-admin/post-new.php |
|
| 1371 | - * |
|
| 1372 | - * @access protected |
|
| 1373 | - * @return void |
|
| 1374 | - */ |
|
| 1375 | - protected function _create_new_cpt_item() |
|
| 1376 | - { |
|
| 1377 | - // gather template vars for WP_ADMIN_PATH . 'edit-form-advanced.php' |
|
| 1378 | - global $post, $title, $is_IE, $post_type, $post_type_object; |
|
| 1379 | - $post_type = $this->_cpt_routes[$this->_req_action]; |
|
| 1380 | - $post_type_object = $this->_cpt_object; |
|
| 1381 | - $title = $post_type_object->labels->add_new_item; |
|
| 1382 | - $editing = true; |
|
| 1383 | - wp_enqueue_script('autosave'); |
|
| 1384 | - $post = $post = get_default_post_to_edit($this->_cpt_routes[$this->_req_action], true); |
|
| 1385 | - $post_ID = $post->ID; |
|
| 1386 | - add_action('admin_print_styles', array($this, 'add_new_admin_page_global')); |
|
| 1387 | - //modify the default editor title field with default title. |
|
| 1388 | - add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10); |
|
| 1389 | - include_once WP_ADMIN_PATH . 'edit-form-advanced.php'; |
|
| 1390 | - } |
|
| 1391 | - |
|
| 1392 | - |
|
| 1393 | - |
|
| 1394 | - public function add_new_admin_page_global() |
|
| 1395 | - { |
|
| 1396 | - $admin_page = ! empty($this->_req_data['post']) ? 'post-php' : 'post-new-php'; |
|
| 1397 | - ?> |
|
| 1322 | + $messages[$post->post_type] = array( |
|
| 1323 | + 0 => '', //Unused. Messages start at index 1. |
|
| 1324 | + 1 => sprintf( |
|
| 1325 | + __('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'), |
|
| 1326 | + $this->_cpt_object->labels->singular_name, |
|
| 1327 | + '<a href="' . esc_url(get_permalink($id)) . '">', |
|
| 1328 | + '</a>' |
|
| 1329 | + ), |
|
| 1330 | + 2 => __('Custom field updated'), |
|
| 1331 | + 3 => __('Custom field deleted.'), |
|
| 1332 | + 4 => sprintf(__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name), |
|
| 1333 | + 5 => isset($_GET['revision']) ? sprintf(__('%s restored to revision from %s', 'event_espresso'), |
|
| 1334 | + $this->_cpt_object->labels->singular_name, wp_post_revision_title((int)$_GET['revision'], false)) |
|
| 1335 | + : false, |
|
| 1336 | + 6 => sprintf( |
|
| 1337 | + __('%1$s published. %2$sView %1$s%3$s', 'event_espresso'), |
|
| 1338 | + $this->_cpt_object->labels->singular_name, |
|
| 1339 | + '<a href="' . esc_url(get_permalink($id)) . '">', |
|
| 1340 | + '</a>' |
|
| 1341 | + ), |
|
| 1342 | + 7 => sprintf(__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name), |
|
| 1343 | + 8 => sprintf( |
|
| 1344 | + __('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'), |
|
| 1345 | + $this->_cpt_object->labels->singular_name, |
|
| 1346 | + '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">', |
|
| 1347 | + '</a>' |
|
| 1348 | + ), |
|
| 1349 | + 9 => sprintf( |
|
| 1350 | + __('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'), |
|
| 1351 | + $this->_cpt_object->labels->singular_name, |
|
| 1352 | + '<strong>' . date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)) . '</strong>', |
|
| 1353 | + '<a target="_blank" href="' . esc_url(get_permalink($id)), |
|
| 1354 | + '</a>' |
|
| 1355 | + ), |
|
| 1356 | + 10 => sprintf( |
|
| 1357 | + __('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'), |
|
| 1358 | + $this->_cpt_object->labels->singular_name, |
|
| 1359 | + '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))), |
|
| 1360 | + '</a>' |
|
| 1361 | + ), |
|
| 1362 | + ); |
|
| 1363 | + return $messages; |
|
| 1364 | + } |
|
| 1365 | + |
|
| 1366 | + |
|
| 1367 | + |
|
| 1368 | + /** |
|
| 1369 | + * default method for the 'create_new' route for cpt admin pages. |
|
| 1370 | + * For reference what to include in here, see wp-admin/post-new.php |
|
| 1371 | + * |
|
| 1372 | + * @access protected |
|
| 1373 | + * @return void |
|
| 1374 | + */ |
|
| 1375 | + protected function _create_new_cpt_item() |
|
| 1376 | + { |
|
| 1377 | + // gather template vars for WP_ADMIN_PATH . 'edit-form-advanced.php' |
|
| 1378 | + global $post, $title, $is_IE, $post_type, $post_type_object; |
|
| 1379 | + $post_type = $this->_cpt_routes[$this->_req_action]; |
|
| 1380 | + $post_type_object = $this->_cpt_object; |
|
| 1381 | + $title = $post_type_object->labels->add_new_item; |
|
| 1382 | + $editing = true; |
|
| 1383 | + wp_enqueue_script('autosave'); |
|
| 1384 | + $post = $post = get_default_post_to_edit($this->_cpt_routes[$this->_req_action], true); |
|
| 1385 | + $post_ID = $post->ID; |
|
| 1386 | + add_action('admin_print_styles', array($this, 'add_new_admin_page_global')); |
|
| 1387 | + //modify the default editor title field with default title. |
|
| 1388 | + add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10); |
|
| 1389 | + include_once WP_ADMIN_PATH . 'edit-form-advanced.php'; |
|
| 1390 | + } |
|
| 1391 | + |
|
| 1392 | + |
|
| 1393 | + |
|
| 1394 | + public function add_new_admin_page_global() |
|
| 1395 | + { |
|
| 1396 | + $admin_page = ! empty($this->_req_data['post']) ? 'post-php' : 'post-new-php'; |
|
| 1397 | + ?> |
|
| 1398 | 1398 | <script type="text/javascript"> |
| 1399 | 1399 | adminpage = '<?php echo $admin_page; ?>'; |
| 1400 | 1400 | </script> |
| 1401 | 1401 | <?php |
| 1402 | - } |
|
| 1403 | - |
|
| 1404 | - |
|
| 1405 | - |
|
| 1406 | - /** |
|
| 1407 | - * default method for the 'edit' route for cpt admin pages |
|
| 1408 | - * For reference on what to put in here, refer to wp-admin/post.php |
|
| 1409 | - * |
|
| 1410 | - * @access protected |
|
| 1411 | - * @return string template for edit cpt form |
|
| 1412 | - */ |
|
| 1413 | - protected function _edit_cpt_item() |
|
| 1414 | - { |
|
| 1415 | - global $post, $title, $is_IE, $post_type, $post_type_object; |
|
| 1416 | - $post_id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null; |
|
| 1417 | - $post = ! empty($post_id) ? get_post($post_id, OBJECT, 'edit') : null; |
|
| 1418 | - if (empty ($post)) { |
|
| 1419 | - wp_die(__('You attempted to edit an item that doesn’t exist. Perhaps it was deleted?')); |
|
| 1420 | - } |
|
| 1421 | - if ( ! empty($_GET['get-post-lock'])) { |
|
| 1422 | - wp_set_post_lock($post_id); |
|
| 1423 | - wp_redirect(get_edit_post_link($post_id, 'url')); |
|
| 1424 | - exit(); |
|
| 1425 | - } |
|
| 1426 | - |
|
| 1427 | - // template vars for WP_ADMIN_PATH . 'edit-form-advanced.php' |
|
| 1428 | - $editing = true; |
|
| 1429 | - $post_ID = $post_id; |
|
| 1430 | - $post_type = $this->_cpt_routes[$this->_req_action]; |
|
| 1431 | - $post_type_object = $this->_cpt_object; |
|
| 1432 | - |
|
| 1433 | - if ( ! wp_check_post_lock($post->ID)) { |
|
| 1434 | - $active_post_lock = wp_set_post_lock($post->ID); |
|
| 1435 | - //wp_enqueue_script('autosave'); |
|
| 1436 | - } |
|
| 1437 | - $title = $this->_cpt_object->labels->edit_item; |
|
| 1438 | - add_action('admin_footer', '_admin_notice_post_locked'); |
|
| 1439 | - if (isset($this->_cpt_routes[$this->_req_data['action']]) |
|
| 1440 | - && ! isset($this->_labels['hide_add_button_on_cpt_route'][$this->_req_data['action']]) |
|
| 1441 | - ) { |
|
| 1442 | - $create_new_action = apply_filters('FHEE__EE_Admin_Page_CPT___edit_cpt_item__create_new_action', |
|
| 1443 | - 'create_new', $this); |
|
| 1444 | - $post_new_file = EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1445 | - 'action' => $create_new_action, |
|
| 1446 | - 'page' => $this->page_slug, |
|
| 1447 | - ), 'admin.php'); |
|
| 1448 | - } |
|
| 1449 | - if (post_type_supports($this->_cpt_routes[$this->_req_action], 'comments')) { |
|
| 1450 | - wp_enqueue_script('admin-comments'); |
|
| 1451 | - enqueue_comment_hotkeys_js(); |
|
| 1452 | - } |
|
| 1453 | - add_action('admin_print_styles', array($this, 'add_new_admin_page_global')); |
|
| 1454 | - //modify the default editor title field with default title. |
|
| 1455 | - add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10); |
|
| 1456 | - include_once WP_ADMIN_PATH . 'edit-form-advanced.php'; |
|
| 1457 | - } |
|
| 1458 | - |
|
| 1459 | - |
|
| 1460 | - |
|
| 1461 | - /** |
|
| 1462 | - * some getters |
|
| 1463 | - */ |
|
| 1464 | - /** |
|
| 1465 | - * This returns the protected _cpt_model_obj property |
|
| 1466 | - * |
|
| 1467 | - * @return EE_CPT_Base |
|
| 1468 | - */ |
|
| 1469 | - public function get_cpt_model_obj() |
|
| 1470 | - { |
|
| 1471 | - return $this->_cpt_model_obj; |
|
| 1472 | - } |
|
| 1402 | + } |
|
| 1403 | + |
|
| 1404 | + |
|
| 1405 | + |
|
| 1406 | + /** |
|
| 1407 | + * default method for the 'edit' route for cpt admin pages |
|
| 1408 | + * For reference on what to put in here, refer to wp-admin/post.php |
|
| 1409 | + * |
|
| 1410 | + * @access protected |
|
| 1411 | + * @return string template for edit cpt form |
|
| 1412 | + */ |
|
| 1413 | + protected function _edit_cpt_item() |
|
| 1414 | + { |
|
| 1415 | + global $post, $title, $is_IE, $post_type, $post_type_object; |
|
| 1416 | + $post_id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null; |
|
| 1417 | + $post = ! empty($post_id) ? get_post($post_id, OBJECT, 'edit') : null; |
|
| 1418 | + if (empty ($post)) { |
|
| 1419 | + wp_die(__('You attempted to edit an item that doesn’t exist. Perhaps it was deleted?')); |
|
| 1420 | + } |
|
| 1421 | + if ( ! empty($_GET['get-post-lock'])) { |
|
| 1422 | + wp_set_post_lock($post_id); |
|
| 1423 | + wp_redirect(get_edit_post_link($post_id, 'url')); |
|
| 1424 | + exit(); |
|
| 1425 | + } |
|
| 1426 | + |
|
| 1427 | + // template vars for WP_ADMIN_PATH . 'edit-form-advanced.php' |
|
| 1428 | + $editing = true; |
|
| 1429 | + $post_ID = $post_id; |
|
| 1430 | + $post_type = $this->_cpt_routes[$this->_req_action]; |
|
| 1431 | + $post_type_object = $this->_cpt_object; |
|
| 1432 | + |
|
| 1433 | + if ( ! wp_check_post_lock($post->ID)) { |
|
| 1434 | + $active_post_lock = wp_set_post_lock($post->ID); |
|
| 1435 | + //wp_enqueue_script('autosave'); |
|
| 1436 | + } |
|
| 1437 | + $title = $this->_cpt_object->labels->edit_item; |
|
| 1438 | + add_action('admin_footer', '_admin_notice_post_locked'); |
|
| 1439 | + if (isset($this->_cpt_routes[$this->_req_data['action']]) |
|
| 1440 | + && ! isset($this->_labels['hide_add_button_on_cpt_route'][$this->_req_data['action']]) |
|
| 1441 | + ) { |
|
| 1442 | + $create_new_action = apply_filters('FHEE__EE_Admin_Page_CPT___edit_cpt_item__create_new_action', |
|
| 1443 | + 'create_new', $this); |
|
| 1444 | + $post_new_file = EE_Admin_Page::add_query_args_and_nonce(array( |
|
| 1445 | + 'action' => $create_new_action, |
|
| 1446 | + 'page' => $this->page_slug, |
|
| 1447 | + ), 'admin.php'); |
|
| 1448 | + } |
|
| 1449 | + if (post_type_supports($this->_cpt_routes[$this->_req_action], 'comments')) { |
|
| 1450 | + wp_enqueue_script('admin-comments'); |
|
| 1451 | + enqueue_comment_hotkeys_js(); |
|
| 1452 | + } |
|
| 1453 | + add_action('admin_print_styles', array($this, 'add_new_admin_page_global')); |
|
| 1454 | + //modify the default editor title field with default title. |
|
| 1455 | + add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10); |
|
| 1456 | + include_once WP_ADMIN_PATH . 'edit-form-advanced.php'; |
|
| 1457 | + } |
|
| 1458 | + |
|
| 1459 | + |
|
| 1460 | + |
|
| 1461 | + /** |
|
| 1462 | + * some getters |
|
| 1463 | + */ |
|
| 1464 | + /** |
|
| 1465 | + * This returns the protected _cpt_model_obj property |
|
| 1466 | + * |
|
| 1467 | + * @return EE_CPT_Base |
|
| 1468 | + */ |
|
| 1469 | + public function get_cpt_model_obj() |
|
| 1470 | + { |
|
| 1471 | + return $this->_cpt_model_obj; |
|
| 1472 | + } |
|
| 1473 | 1473 | |
| 1474 | 1474 | } |
@@ -235,7 +235,7 @@ discard block |
||
| 235 | 235 | */ |
| 236 | 236 | protected function _register_autosave_containers($ids) |
| 237 | 237 | { |
| 238 | - $this->_autosave_containers = array_merge($this->_autosave_fields, (array)$ids); |
|
| 238 | + $this->_autosave_containers = array_merge($this->_autosave_fields, (array) $ids); |
|
| 239 | 239 | } |
| 240 | 240 | |
| 241 | 241 | |
@@ -282,7 +282,7 @@ discard block |
||
| 282 | 282 | //filter _autosave_containers |
| 283 | 283 | $containers = apply_filters('FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers', |
| 284 | 284 | $this->_autosave_containers, $this); |
| 285 | - $containers = apply_filters('FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers', |
|
| 285 | + $containers = apply_filters('FHEE__EE_Admin_Page_CPT__'.get_class($this).'___load_autosave_scripts_styles__containers', |
|
| 286 | 286 | $containers, $this); |
| 287 | 287 | |
| 288 | 288 | wp_localize_script('event_editor_js', 'EE_AUTOSAVE_IDS', |
@@ -394,7 +394,7 @@ discard block |
||
| 394 | 394 | // This is for any plugins that are doing things properly |
| 395 | 395 | // and hooking into the load page hook for core wp cpt routes. |
| 396 | 396 | global $pagenow; |
| 397 | - do_action('load-' . $pagenow); |
|
| 397 | + do_action('load-'.$pagenow); |
|
| 398 | 398 | $this->modify_current_screen(); |
| 399 | 399 | add_action('admin_enqueue_scripts', array($this, 'setup_autosave_hooks'), 30); |
| 400 | 400 | //we route REALLY early. |
@@ -425,8 +425,8 @@ discard block |
||
| 425 | 425 | 'admin.php?page=espresso_registrations&action=contact_list', |
| 426 | 426 | ), |
| 427 | 427 | 1 => array( |
| 428 | - 'edit.php?post_type=' . $this->_cpt_object->name, |
|
| 429 | - 'admin.php?page=' . $this->_cpt_object->name, |
|
| 428 | + 'edit.php?post_type='.$this->_cpt_object->name, |
|
| 429 | + 'admin.php?page='.$this->_cpt_object->name, |
|
| 430 | 430 | ), |
| 431 | 431 | ); |
| 432 | 432 | foreach ($routes_to_match as $route_matches) { |
@@ -454,7 +454,7 @@ discard block |
||
| 454 | 454 | $cpt_has_support = ! empty($cpt_args['page_templates']); |
| 455 | 455 | |
| 456 | 456 | //if the installed version of WP is > 4.7 we do some additional checks. |
| 457 | - if (EE_Recommended_Versions::check_wp_version('4.7','>=')) { |
|
| 457 | + if (EE_Recommended_Versions::check_wp_version('4.7', '>=')) { |
|
| 458 | 458 | $post_templates = wp_get_theme()->get_post_templates(); |
| 459 | 459 | //if there are $post_templates for this cpt, then we return false for this method because |
| 460 | 460 | //that means we aren't going to load our page template manager and leave that up to the native |
@@ -477,7 +477,7 @@ discard block |
||
| 477 | 477 | global $post; |
| 478 | 478 | $template = ''; |
| 479 | 479 | |
| 480 | - if (EE_Recommended_Versions::check_wp_version('4.7','>=')) { |
|
| 480 | + if (EE_Recommended_Versions::check_wp_version('4.7', '>=')) { |
|
| 481 | 481 | $page_template_count = count(get_page_templates()); |
| 482 | 482 | } else { |
| 483 | 483 | $page_template_count = count(get_page_templates($post)); |
@@ -514,7 +514,7 @@ discard block |
||
| 514 | 514 | $post = get_post($id); |
| 515 | 515 | if ('publish' !== get_post_status($post)) { |
| 516 | 516 | //include shims for the `get_preview_post_link` function |
| 517 | - require_once( EE_CORE . 'wordpress-shims.php' ); |
|
| 517 | + require_once(EE_CORE.'wordpress-shims.php'); |
|
| 518 | 518 | $return .= '<span_id="view-post-btn"><a target="_blank" href="' |
| 519 | 519 | . get_preview_post_link($id) |
| 520 | 520 | . '" class="button button-small">' |
@@ -552,7 +552,7 @@ discard block |
||
| 552 | 552 | $template_args['statuses'] = $statuses; |
| 553 | 553 | } |
| 554 | 554 | |
| 555 | - $template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php'; |
|
| 555 | + $template = EE_ADMIN_TEMPLATE.'status_dropdown.template.php'; |
|
| 556 | 556 | EEH_Template::display_template($template, $template_args); |
| 557 | 557 | } |
| 558 | 558 | |
@@ -606,7 +606,7 @@ discard block |
||
| 606 | 606 | $this->_template_args['success'] = true; |
| 607 | 607 | } |
| 608 | 608 | do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this); |
| 609 | - do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this); |
|
| 609 | + do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_'.get_class($this), $this); |
|
| 610 | 610 | //now let's return json |
| 611 | 611 | $this->_return_json(); |
| 612 | 612 | } |
@@ -1009,7 +1009,7 @@ discard block |
||
| 1009 | 1009 | //global action |
| 1010 | 1010 | do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id); |
| 1011 | 1011 | //class specific action so you can limit hooking into a specific page. |
| 1012 | - do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id); |
|
| 1012 | + do_action('AHEE_EE_Admin_Page_CPT_'.get_class($this).'__restore_revision', $post_id, $revision_id); |
|
| 1013 | 1013 | } |
| 1014 | 1014 | |
| 1015 | 1015 | |
@@ -1087,7 +1087,7 @@ discard block |
||
| 1087 | 1087 | if ( ! empty($id) && get_option('permalink_structure') !== '') { |
| 1088 | 1088 | $post = get_post($id); |
| 1089 | 1089 | if (isset($post->post_type) && $this->page_slug === $post->post_type) { |
| 1090 | - $shortlink = home_url('?p=' . $post->ID); |
|
| 1090 | + $shortlink = home_url('?p='.$post->ID); |
|
| 1091 | 1091 | } |
| 1092 | 1092 | } |
| 1093 | 1093 | return $shortlink; |
@@ -1122,11 +1122,11 @@ discard block |
||
| 1122 | 1122 | */ |
| 1123 | 1123 | public function cpt_post_form_hidden_input() |
| 1124 | 1124 | { |
| 1125 | - echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="' . $this->_admin_base_url . '" />'; |
|
| 1125 | + echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="'.$this->_admin_base_url.'" />'; |
|
| 1126 | 1126 | //we're also going to add the route value and the current page so we can direct autosave parsing correctly |
| 1127 | 1127 | echo '<div id="ee-cpt-hidden-inputs">'; |
| 1128 | - echo '<input type="hidden" id="current_route" name="current_route" value="' . $this->_current_view . '" />'; |
|
| 1129 | - echo '<input type="hidden" id="current_page" name="current_page" value="' . $this->page_slug . '" />'; |
|
| 1128 | + echo '<input type="hidden" id="current_route" name="current_route" value="'.$this->_current_view.'" />'; |
|
| 1129 | + echo '<input type="hidden" id="current_page" name="current_page" value="'.$this->page_slug.'" />'; |
|
| 1130 | 1130 | echo '</div>'; |
| 1131 | 1131 | } |
| 1132 | 1132 | |
@@ -1213,7 +1213,7 @@ discard block |
||
| 1213 | 1213 | $this->_set_model_object($post->ID, true); |
| 1214 | 1214 | |
| 1215 | 1215 | //returns something like `trash_event` or `trash_attendee` or `trash_venue` |
| 1216 | - $action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj))); |
|
| 1216 | + $action = 'trash_'.str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj))); |
|
| 1217 | 1217 | |
| 1218 | 1218 | return EE_Admin_Page::add_query_args_and_nonce( |
| 1219 | 1219 | array( |
@@ -1324,39 +1324,39 @@ discard block |
||
| 1324 | 1324 | 1 => sprintf( |
| 1325 | 1325 | __('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'), |
| 1326 | 1326 | $this->_cpt_object->labels->singular_name, |
| 1327 | - '<a href="' . esc_url(get_permalink($id)) . '">', |
|
| 1327 | + '<a href="'.esc_url(get_permalink($id)).'">', |
|
| 1328 | 1328 | '</a>' |
| 1329 | 1329 | ), |
| 1330 | 1330 | 2 => __('Custom field updated'), |
| 1331 | 1331 | 3 => __('Custom field deleted.'), |
| 1332 | 1332 | 4 => sprintf(__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name), |
| 1333 | 1333 | 5 => isset($_GET['revision']) ? sprintf(__('%s restored to revision from %s', 'event_espresso'), |
| 1334 | - $this->_cpt_object->labels->singular_name, wp_post_revision_title((int)$_GET['revision'], false)) |
|
| 1334 | + $this->_cpt_object->labels->singular_name, wp_post_revision_title((int) $_GET['revision'], false)) |
|
| 1335 | 1335 | : false, |
| 1336 | 1336 | 6 => sprintf( |
| 1337 | 1337 | __('%1$s published. %2$sView %1$s%3$s', 'event_espresso'), |
| 1338 | 1338 | $this->_cpt_object->labels->singular_name, |
| 1339 | - '<a href="' . esc_url(get_permalink($id)) . '">', |
|
| 1339 | + '<a href="'.esc_url(get_permalink($id)).'">', |
|
| 1340 | 1340 | '</a>' |
| 1341 | 1341 | ), |
| 1342 | 1342 | 7 => sprintf(__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name), |
| 1343 | 1343 | 8 => sprintf( |
| 1344 | 1344 | __('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'), |
| 1345 | 1345 | $this->_cpt_object->labels->singular_name, |
| 1346 | - '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">', |
|
| 1346 | + '<a target="_blank" href="'.esc_url(add_query_arg('preview', 'true', get_permalink($id))).'">', |
|
| 1347 | 1347 | '</a>' |
| 1348 | 1348 | ), |
| 1349 | 1349 | 9 => sprintf( |
| 1350 | 1350 | __('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'), |
| 1351 | 1351 | $this->_cpt_object->labels->singular_name, |
| 1352 | - '<strong>' . date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)) . '</strong>', |
|
| 1353 | - '<a target="_blank" href="' . esc_url(get_permalink($id)), |
|
| 1352 | + '<strong>'.date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)).'</strong>', |
|
| 1353 | + '<a target="_blank" href="'.esc_url(get_permalink($id)), |
|
| 1354 | 1354 | '</a>' |
| 1355 | 1355 | ), |
| 1356 | 1356 | 10 => sprintf( |
| 1357 | 1357 | __('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'), |
| 1358 | 1358 | $this->_cpt_object->labels->singular_name, |
| 1359 | - '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))), |
|
| 1359 | + '<a target="_blank" href="'.esc_url(add_query_arg('preview', 'true', get_permalink($id))), |
|
| 1360 | 1360 | '</a>' |
| 1361 | 1361 | ), |
| 1362 | 1362 | ); |
@@ -1386,7 +1386,7 @@ discard block |
||
| 1386 | 1386 | add_action('admin_print_styles', array($this, 'add_new_admin_page_global')); |
| 1387 | 1387 | //modify the default editor title field with default title. |
| 1388 | 1388 | add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10); |
| 1389 | - include_once WP_ADMIN_PATH . 'edit-form-advanced.php'; |
|
| 1389 | + include_once WP_ADMIN_PATH.'edit-form-advanced.php'; |
|
| 1390 | 1390 | } |
| 1391 | 1391 | |
| 1392 | 1392 | |
@@ -1453,7 +1453,7 @@ discard block |
||
| 1453 | 1453 | add_action('admin_print_styles', array($this, 'add_new_admin_page_global')); |
| 1454 | 1454 | //modify the default editor title field with default title. |
| 1455 | 1455 | add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10); |
| 1456 | - include_once WP_ADMIN_PATH . 'edit-form-advanced.php'; |
|
| 1456 | + include_once WP_ADMIN_PATH.'edit-form-advanced.php'; |
|
| 1457 | 1457 | } |
| 1458 | 1458 | |
| 1459 | 1459 | |
@@ -4,7 +4,7 @@ discard block |
||
| 4 | 4 | use EventEspresso\core\services\database\TableAnalysis; |
| 5 | 5 | |
| 6 | 6 | if (!defined('EVENT_ESPRESSO_VERSION')) { |
| 7 | - exit('No direct script access allowed'); |
|
| 7 | + exit('No direct script access allowed'); |
|
| 8 | 8 | } |
| 9 | 9 | |
| 10 | 10 | |
@@ -18,802 +18,802 @@ discard block |
||
| 18 | 18 | class EEM_Registration extends EEM_Soft_Delete_Base |
| 19 | 19 | { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * @var EEM_Registration $_instance |
|
| 23 | - */ |
|
| 24 | - protected static $_instance; |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * Keys are the status IDs for registrations (eg, RAP, RCN, etc), and the values |
|
| 28 | - * are status codes (eg, approved, cancelled, etc) |
|
| 29 | - * |
|
| 30 | - * @var array |
|
| 31 | - */ |
|
| 32 | - private static $_reg_status; |
|
| 33 | - |
|
| 34 | - /** |
|
| 35 | - * The value of REG_count for a primary registrant |
|
| 36 | - */ |
|
| 37 | - const PRIMARY_REGISTRANT_COUNT = 1; |
|
| 38 | - |
|
| 39 | - /** |
|
| 40 | - * Status ID (STS_ID on esp_status table) to indicate an INCOMPLETE registration. |
|
| 41 | - * Initial status for registrations when they are first created |
|
| 42 | - * Payments are NOT allowed. |
|
| 43 | - * Automatically toggled to whatever the default Event registration status is upon completion of the attendee |
|
| 44 | - * information reg step NO space reserved. Registration is NOT active |
|
| 45 | - */ |
|
| 46 | - const status_id_incomplete = 'RIC'; |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * Status ID (STS_ID on esp_status table) to indicate an UNAPPROVED registration. |
|
| 50 | - * Payments are NOT allowed. |
|
| 51 | - * Event Admin must manually toggle STS_ID for it to change |
|
| 52 | - * No space reserved. |
|
| 53 | - * Registration is active |
|
| 54 | - */ |
|
| 55 | - const status_id_not_approved = 'RNA'; |
|
| 56 | - |
|
| 57 | - /** |
|
| 58 | - * Status ID (STS_ID on esp_status table) to indicate registration is PENDING_PAYMENT . |
|
| 59 | - * Payments are allowed. |
|
| 60 | - * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee |
|
| 61 | - * No space reserved. |
|
| 62 | - * Registration is active |
|
| 63 | - */ |
|
| 64 | - const status_id_pending_payment = 'RPP'; |
|
| 65 | - |
|
| 66 | - /** |
|
| 67 | - * Status ID (STS_ID on esp_status table) to indicate registration is on the WAIT_LIST . |
|
| 68 | - * Payments are allowed. |
|
| 69 | - * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee |
|
| 70 | - * No space reserved. |
|
| 71 | - * Registration is active |
|
| 72 | - */ |
|
| 73 | - const status_id_wait_list = 'RWL'; |
|
| 74 | - |
|
| 75 | - /** |
|
| 76 | - * Status ID (STS_ID on esp_status table) to indicate an APPROVED registration. |
|
| 77 | - * the TXN may or may not be completed ( paid in full ) |
|
| 78 | - * Payments are allowed. |
|
| 79 | - * A space IS reserved. |
|
| 80 | - * Registration is active |
|
| 81 | - */ |
|
| 82 | - const status_id_approved = 'RAP'; |
|
| 83 | - |
|
| 84 | - /** |
|
| 85 | - * Status ID (STS_ID on esp_status table) to indicate a registration was CANCELLED by the attendee. |
|
| 86 | - * Payments are NOT allowed. |
|
| 87 | - * NO space reserved. |
|
| 88 | - * Registration is NOT active |
|
| 89 | - */ |
|
| 90 | - const status_id_cancelled = 'RCN'; |
|
| 91 | - |
|
| 92 | - /** |
|
| 93 | - * Status ID (STS_ID on esp_status table) to indicate a registration was DECLINED by the Event Admin |
|
| 94 | - * Payments are NOT allowed. |
|
| 95 | - * No space reserved. |
|
| 96 | - * Registration is NOT active |
|
| 97 | - */ |
|
| 98 | - const status_id_declined = 'RDC'; |
|
| 99 | - |
|
| 100 | - /** |
|
| 101 | - * @var TableAnalysis $table_analysis |
|
| 102 | - */ |
|
| 103 | - protected $_table_analysis; |
|
| 104 | - |
|
| 105 | - |
|
| 106 | - /** |
|
| 107 | - * private constructor to prevent direct creation |
|
| 108 | - * |
|
| 109 | - * @Constructor |
|
| 110 | - * @access protected |
|
| 111 | - * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any |
|
| 112 | - * incoming timezone data that gets saved). Note this just sends the timezone info to the |
|
| 113 | - * date time model field objects. Default is NULL (and will be assumed using the set |
|
| 114 | - * timezone in the 'timezone_string' wp option) |
|
| 115 | - * @throws EE_Error |
|
| 116 | - */ |
|
| 117 | - protected function __construct($timezone = null) |
|
| 118 | - { |
|
| 119 | - $this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true); |
|
| 120 | - $this->singular_item = esc_html__('Registration', 'event_espresso'); |
|
| 121 | - $this->plural_item = esc_html__('Registrations', 'event_espresso'); |
|
| 122 | - $this->_tables = array( |
|
| 123 | - 'Registration' => new EE_Primary_Table('esp_registration', 'REG_ID'), |
|
| 124 | - ); |
|
| 125 | - $this->_fields = array( |
|
| 126 | - 'Registration' => array( |
|
| 127 | - 'REG_ID' => new EE_Primary_Key_Int_Field( |
|
| 128 | - 'REG_ID', |
|
| 129 | - esc_html__('Registration ID', 'event_espresso') |
|
| 130 | - ), |
|
| 131 | - 'EVT_ID' => new EE_Foreign_Key_Int_Field( |
|
| 132 | - 'EVT_ID', |
|
| 133 | - esc_html__('Event ID', 'event_espresso'), |
|
| 134 | - false, |
|
| 135 | - 0, |
|
| 136 | - 'Event' |
|
| 137 | - ), |
|
| 138 | - 'ATT_ID' => new EE_Foreign_Key_Int_Field( |
|
| 139 | - 'ATT_ID', |
|
| 140 | - esc_html__('Attendee ID', 'event_espresso'), |
|
| 141 | - false, |
|
| 142 | - 0, |
|
| 143 | - 'Attendee' |
|
| 144 | - ), |
|
| 145 | - 'TXN_ID' => new EE_Foreign_Key_Int_Field( |
|
| 146 | - 'TXN_ID', |
|
| 147 | - esc_html__('Transaction ID', 'event_espresso'), |
|
| 148 | - false, 0, 'Transaction' |
|
| 149 | - ), |
|
| 150 | - 'TKT_ID' => new EE_Foreign_Key_Int_Field( |
|
| 151 | - 'TKT_ID', |
|
| 152 | - esc_html__('Ticket ID', 'event_espresso'), |
|
| 153 | - false, |
|
| 154 | - 0, 'Ticket' |
|
| 155 | - ), |
|
| 156 | - 'STS_ID' => new EE_Foreign_Key_String_Field( |
|
| 157 | - 'STS_ID', |
|
| 158 | - esc_html__('Status ID', 'event_espresso'), |
|
| 159 | - false, |
|
| 160 | - EEM_Registration::status_id_incomplete, |
|
| 161 | - 'Status' |
|
| 162 | - ), |
|
| 163 | - 'REG_date' => new EE_Datetime_Field( |
|
| 164 | - 'REG_date', |
|
| 165 | - esc_html__('Time registration occurred', 'event_espresso'), |
|
| 166 | - false, |
|
| 167 | - EE_Datetime_Field::now, |
|
| 168 | - $timezone |
|
| 169 | - ), |
|
| 170 | - 'REG_final_price' => new EE_Money_Field( |
|
| 171 | - 'REG_final_price', |
|
| 172 | - esc_html__('Registration\'s share of the transaction total', 'event_espresso'), |
|
| 173 | - false, |
|
| 174 | - 0 |
|
| 175 | - ), |
|
| 176 | - 'REG_paid' => new EE_Money_Field( |
|
| 177 | - 'REG_paid', |
|
| 178 | - esc_html__('Amount paid to date towards registration', 'event_espresso'), |
|
| 179 | - false, |
|
| 180 | - 0 |
|
| 181 | - ), |
|
| 182 | - 'REG_session' => new EE_Plain_Text_Field( |
|
| 183 | - 'REG_session', |
|
| 184 | - esc_html__('Session ID of registration', 'event_espresso'), |
|
| 185 | - false, |
|
| 186 | - '' |
|
| 187 | - ), |
|
| 188 | - 'REG_code' => new EE_Plain_Text_Field( |
|
| 189 | - 'REG_code', |
|
| 190 | - esc_html__('Unique Code for this registration', 'event_espresso'), |
|
| 191 | - false, |
|
| 192 | - '' |
|
| 193 | - ), |
|
| 194 | - 'REG_url_link' => new EE_Plain_Text_Field( |
|
| 195 | - 'REG_url_link', |
|
| 196 | - esc_html__('String to be used in URL for identifying registration', 'event_espresso'), |
|
| 197 | - false, |
|
| 198 | - '' |
|
| 199 | - ), |
|
| 200 | - 'REG_count' => new EE_Integer_Field( |
|
| 201 | - 'REG_count', |
|
| 202 | - esc_html__('Count of this registration in the group registration ', 'event_espresso'), |
|
| 203 | - true, |
|
| 204 | - 1 |
|
| 205 | - ), |
|
| 206 | - 'REG_group_size' => new EE_Integer_Field( |
|
| 207 | - 'REG_group_size', |
|
| 208 | - esc_html__('Number of registrations on this group', 'event_espresso'), |
|
| 209 | - false, |
|
| 210 | - 1 |
|
| 211 | - ), |
|
| 212 | - 'REG_att_is_going' => new EE_Boolean_Field( |
|
| 213 | - 'REG_att_is_going', |
|
| 214 | - esc_html__('Flag indicating the registrant plans on attending', 'event_espresso'), |
|
| 215 | - false, |
|
| 216 | - false |
|
| 217 | - ), |
|
| 218 | - 'REG_deleted' => new EE_Trashed_Flag_Field( |
|
| 219 | - 'REG_deleted', |
|
| 220 | - esc_html__('Flag indicating if registration has been archived or not.', 'event_espresso'), |
|
| 221 | - false, |
|
| 222 | - false |
|
| 223 | - ), |
|
| 224 | - ), |
|
| 225 | - ); |
|
| 226 | - $this->_model_relations = array( |
|
| 227 | - 'Event' => new EE_Belongs_To_Relation(), |
|
| 228 | - 'Attendee' => new EE_Belongs_To_Relation(), |
|
| 229 | - 'Transaction' => new EE_Belongs_To_Relation(), |
|
| 230 | - 'Ticket' => new EE_Belongs_To_Relation(), |
|
| 231 | - 'Status' => new EE_Belongs_To_Relation(), |
|
| 232 | - 'Answer' => new EE_Has_Many_Relation(), |
|
| 233 | - 'Checkin' => new EE_Has_Many_Relation(), |
|
| 234 | - 'Registration_Payment' => new EE_Has_Many_Relation(), |
|
| 235 | - 'Payment' => new EE_HABTM_Relation('Registration_Payment'), |
|
| 236 | - 'Message' => new EE_Has_Many_Any_Relation(false) |
|
| 237 | - //allow deletes even if there are messages in the queue related |
|
| 238 | - ); |
|
| 239 | - $this->_model_chain_to_wp_user = 'Event'; |
|
| 240 | - parent::__construct($timezone); |
|
| 241 | - } |
|
| 242 | - |
|
| 243 | - |
|
| 244 | - /** |
|
| 245 | - * a list of ALL valid registration statuses currently in use within the system |
|
| 246 | - * generated by combining the filterable active and inactive reg status arrays |
|
| 247 | - * |
|
| 248 | - * @return array |
|
| 249 | - */ |
|
| 250 | - public static function reg_statuses() |
|
| 251 | - { |
|
| 252 | - return array_unique( |
|
| 253 | - array_merge( |
|
| 254 | - EEM_Registration::active_reg_statuses(), |
|
| 255 | - EEM_Registration::inactive_reg_statuses() |
|
| 256 | - ) |
|
| 257 | - ); |
|
| 258 | - } |
|
| 259 | - |
|
| 260 | - |
|
| 261 | - /** |
|
| 262 | - * reg_statuses_that_allow_payment |
|
| 263 | - * a filterable list of registration statuses that allow a registrant to make a payment |
|
| 264 | - * |
|
| 265 | - * @access public |
|
| 266 | - * @return array |
|
| 267 | - */ |
|
| 268 | - public static function reg_statuses_that_allow_payment() |
|
| 269 | - { |
|
| 270 | - return apply_filters( |
|
| 271 | - 'FHEE__EEM_Registration__reg_statuses_that_allow_payment', |
|
| 272 | - array( |
|
| 273 | - EEM_Registration::status_id_approved, |
|
| 274 | - EEM_Registration::status_id_pending_payment, |
|
| 275 | - ) |
|
| 276 | - ); |
|
| 277 | - } |
|
| 278 | - |
|
| 279 | - |
|
| 280 | - /** |
|
| 281 | - * active_reg_statuses |
|
| 282 | - * a filterable list of registration statuses that are considered active |
|
| 283 | - * |
|
| 284 | - * @access public |
|
| 285 | - * @return array |
|
| 286 | - */ |
|
| 287 | - public static function active_reg_statuses() |
|
| 288 | - { |
|
| 289 | - return apply_filters( |
|
| 290 | - 'FHEE__EEM_Registration__active_reg_statuses', |
|
| 291 | - array( |
|
| 292 | - EEM_Registration::status_id_approved, |
|
| 293 | - EEM_Registration::status_id_pending_payment, |
|
| 294 | - EEM_Registration::status_id_wait_list, |
|
| 295 | - EEM_Registration::status_id_not_approved, |
|
| 296 | - ) |
|
| 297 | - ); |
|
| 298 | - } |
|
| 299 | - |
|
| 300 | - |
|
| 301 | - /** |
|
| 302 | - * inactive_reg_statuses |
|
| 303 | - * a filterable list of registration statuses that are not considered active |
|
| 304 | - * |
|
| 305 | - * @access public |
|
| 306 | - * @return array |
|
| 307 | - */ |
|
| 308 | - public static function inactive_reg_statuses() |
|
| 309 | - { |
|
| 310 | - return apply_filters( |
|
| 311 | - 'FHEE__EEM_Registration__inactive_reg_statuses', |
|
| 312 | - array( |
|
| 313 | - EEM_Registration::status_id_incomplete, |
|
| 314 | - EEM_Registration::status_id_cancelled, |
|
| 315 | - EEM_Registration::status_id_declined, |
|
| 316 | - ) |
|
| 317 | - ); |
|
| 318 | - } |
|
| 319 | - |
|
| 320 | - |
|
| 321 | - /** |
|
| 322 | - * closed_reg_statuses |
|
| 323 | - * a filterable list of registration statuses that are considered "closed" |
|
| 324 | - * meaning they should not be considered in any calculations involving monies owing |
|
| 325 | - * |
|
| 326 | - * @access public |
|
| 327 | - * @return array |
|
| 328 | - */ |
|
| 329 | - public static function closed_reg_statuses() |
|
| 330 | - { |
|
| 331 | - return apply_filters( |
|
| 332 | - 'FHEE__EEM_Registration__closed_reg_statuses', |
|
| 333 | - array( |
|
| 334 | - EEM_Registration::status_id_cancelled, |
|
| 335 | - EEM_Registration::status_id_declined, |
|
| 336 | - EEM_Registration::status_id_wait_list, |
|
| 337 | - ) |
|
| 338 | - ); |
|
| 339 | - } |
|
| 340 | - |
|
| 341 | - |
|
| 342 | - /** |
|
| 343 | - * get list of registration statuses |
|
| 344 | - * |
|
| 345 | - * @access public |
|
| 346 | - * @param array $exclude The status ids to exclude from the returned results |
|
| 347 | - * @param bool $translated If true will return the values as singular localized strings |
|
| 348 | - * @return array |
|
| 349 | - * @throws EE_Error |
|
| 350 | - */ |
|
| 351 | - public static function reg_status_array($exclude = array(), $translated = false) |
|
| 352 | - { |
|
| 353 | - EEM_Registration::instance()->_get_registration_status_array($exclude); |
|
| 354 | - return $translated |
|
| 355 | - ? EEM_Status::instance()->localized_status(self::$_reg_status, false, 'sentence') |
|
| 356 | - : self::$_reg_status; |
|
| 357 | - } |
|
| 358 | - |
|
| 359 | - |
|
| 360 | - /** |
|
| 361 | - * get list of registration statuses |
|
| 362 | - * |
|
| 363 | - * @access private |
|
| 364 | - * @param array $exclude |
|
| 365 | - * @return void |
|
| 366 | - * @throws EE_Error |
|
| 367 | - */ |
|
| 368 | - private function _get_registration_status_array($exclude = array()) |
|
| 369 | - { |
|
| 370 | - //in the very rare circumstance that we are deleting a model's table's data |
|
| 371 | - //and the table hasn't actually been created, this could have an error |
|
| 372 | - /** @type WPDB $wpdb */ |
|
| 373 | - global $wpdb; |
|
| 374 | - if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) { |
|
| 375 | - $results = $wpdb->get_results( |
|
| 376 | - "SELECT STS_ID, STS_code FROM {$wpdb->prefix}esp_status WHERE STS_type = 'registration'" |
|
| 377 | - ); |
|
| 378 | - self::$_reg_status = array(); |
|
| 379 | - foreach ($results as $status) { |
|
| 380 | - if (!in_array($status->STS_ID, $exclude, true)) { |
|
| 381 | - self::$_reg_status[$status->STS_ID] = $status->STS_code; |
|
| 382 | - } |
|
| 383 | - } |
|
| 384 | - } |
|
| 385 | - } |
|
| 386 | - |
|
| 387 | - |
|
| 388 | - /** |
|
| 389 | - * Gets the injected table analyzer, or throws an exception |
|
| 390 | - * |
|
| 391 | - * @return TableAnalysis |
|
| 392 | - * @throws EE_Error |
|
| 393 | - */ |
|
| 394 | - protected function _get_table_analysis() |
|
| 395 | - { |
|
| 396 | - if ($this->_table_analysis instanceof TableAnalysis) { |
|
| 397 | - return $this->_table_analysis; |
|
| 398 | - } |
|
| 399 | - throw new EE_Error( |
|
| 400 | - sprintf( |
|
| 401 | - esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'), |
|
| 402 | - get_class($this) |
|
| 403 | - ) |
|
| 404 | - ); |
|
| 405 | - } |
|
| 406 | - |
|
| 407 | - |
|
| 408 | - /** |
|
| 409 | - * This returns a wpdb->results array of all registration date month and years matching the incoming query params |
|
| 410 | - * and grouped by month and year. |
|
| 411 | - * |
|
| 412 | - * @param array $where_params Array of query_params as described in the comments for EEM_Base::get_all() |
|
| 413 | - * @return array |
|
| 414 | - * @throws EE_Error |
|
| 415 | - */ |
|
| 416 | - public function get_reg_months_and_years($where_params) |
|
| 417 | - { |
|
| 418 | - $query_params[0] = $where_params; |
|
| 419 | - $query_params['group_by'] = array('reg_year', 'reg_month'); |
|
| 420 | - $query_params['order_by'] = array('REG_date' => 'DESC'); |
|
| 421 | - $columns_to_select = array( |
|
| 422 | - 'reg_year' => array('YEAR(REG_date)', '%s'), |
|
| 423 | - 'reg_month' => array('MONTHNAME(REG_date)', '%s'), |
|
| 424 | - ); |
|
| 425 | - return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select); |
|
| 426 | - } |
|
| 427 | - |
|
| 428 | - |
|
| 429 | - /** |
|
| 430 | - * retrieve ALL registrations for a particular Attendee from db |
|
| 431 | - * |
|
| 432 | - * @param int $ATT_ID |
|
| 433 | - * @return EE_Base_Class[]|EE_Registration[]|null |
|
| 434 | - * @throws EE_Error |
|
| 435 | - */ |
|
| 436 | - public function get_all_registrations_for_attendee($ATT_ID = 0) |
|
| 437 | - { |
|
| 438 | - if (!$ATT_ID) { |
|
| 439 | - return null; |
|
| 440 | - } |
|
| 441 | - return $this->get_all(array(array('ATT_ID' => $ATT_ID))); |
|
| 442 | - } |
|
| 443 | - |
|
| 444 | - |
|
| 445 | - /** |
|
| 446 | - * Gets a registration given their REG_url_link. Yes, this should usually |
|
| 447 | - * be passed via a GET parameter. |
|
| 448 | - * |
|
| 449 | - * @param string $REG_url_link |
|
| 450 | - * @return EE_Base_Class|EE_Registration|null |
|
| 451 | - * @throws EE_Error |
|
| 452 | - */ |
|
| 453 | - public function get_registration_for_reg_url_link($REG_url_link) |
|
| 454 | - { |
|
| 455 | - if (!$REG_url_link) { |
|
| 456 | - return null; |
|
| 457 | - } |
|
| 458 | - return $this->get_one(array(array('REG_url_link' => $REG_url_link))); |
|
| 459 | - } |
|
| 460 | - |
|
| 461 | - |
|
| 462 | - /** |
|
| 463 | - * retrieve registration for a specific transaction attendee from db |
|
| 464 | - * |
|
| 465 | - * @access public |
|
| 466 | - * @param int $TXN_ID |
|
| 467 | - * @param int $ATT_ID |
|
| 468 | - * @param int $att_nmbr in case the ATT_ID is the same for multiple registrations (same details used) then the |
|
| 469 | - * attendee number is required |
|
| 470 | - * @return mixed array on success, FALSE on fail |
|
| 471 | - * @throws EE_Error |
|
| 472 | - */ |
|
| 473 | - public function get_registration_for_transaction_attendee($TXN_ID = 0, $ATT_ID = 0, $att_nmbr = 0) |
|
| 474 | - { |
|
| 475 | - return $this->get_one(array( |
|
| 476 | - array( |
|
| 477 | - 'TXN_ID' => $TXN_ID, |
|
| 478 | - 'ATT_ID' => $ATT_ID, |
|
| 479 | - ), |
|
| 480 | - 'limit' => array(min($att_nmbr - 1, 0), 1), |
|
| 481 | - )); |
|
| 482 | - } |
|
| 483 | - |
|
| 484 | - |
|
| 485 | - /** |
|
| 486 | - * get the number of registrations per day for the Registration Admin page Reports Tab. |
|
| 487 | - * (doesn't utilize models because it's a fairly specialized query) |
|
| 488 | - * |
|
| 489 | - * @access public |
|
| 490 | - * @param $period string which can be passed to php's strtotime function (eg "-1 month") |
|
| 491 | - * @return stdClass[] with properties regDate and total |
|
| 492 | - * @throws EE_Error |
|
| 493 | - */ |
|
| 494 | - public function get_registrations_per_day_report($period = '-1 month') |
|
| 495 | - { |
|
| 496 | - $sql_date = $this->convert_datetime_for_query('REG_date', date('Y-m-d H:i:s', strtotime($period)), |
|
| 497 | - 'Y-m-d H:i:s', 'UTC'); |
|
| 498 | - $where = array( |
|
| 499 | - 'REG_date' => array('>=', $sql_date), |
|
| 500 | - 'STS_ID' => array('!=', EEM_Registration::status_id_incomplete), |
|
| 501 | - ); |
|
| 502 | - if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) { |
|
| 503 | - $where['Event.EVT_wp_user'] = get_current_user_id(); |
|
| 504 | - } |
|
| 505 | - $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'REG_date'); |
|
| 506 | - $results = $this->_get_all_wpdb_results( |
|
| 507 | - array( |
|
| 508 | - $where, |
|
| 509 | - 'group_by' => 'regDate', |
|
| 510 | - 'order_by' => array('REG_date' => 'ASC'), |
|
| 511 | - ), |
|
| 512 | - OBJECT, |
|
| 513 | - array( |
|
| 514 | - 'regDate' => array('DATE(' . $query_interval . ')', '%s'), |
|
| 515 | - 'total' => array('count(REG_ID)', '%d'), |
|
| 516 | - )); |
|
| 517 | - return $results; |
|
| 518 | - } |
|
| 519 | - |
|
| 520 | - |
|
| 521 | - /** |
|
| 522 | - * Get the number of registrations per day including the count of registrations for each Registration Status. |
|
| 523 | - * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results. |
|
| 524 | - * |
|
| 525 | - * @param string $period |
|
| 526 | - * @return stdClass[] with properties Registration_REG_date and a column for each registration status as the STS_ID |
|
| 527 | - * @throws EE_Error |
|
| 528 | - * (i.e. RAP) |
|
| 529 | - */ |
|
| 530 | - public function get_registrations_per_day_and_per_status_report($period = '-1 month') |
|
| 531 | - { |
|
| 532 | - global $wpdb; |
|
| 533 | - $registration_table = $wpdb->prefix . 'esp_registration'; |
|
| 534 | - $event_table = $wpdb->posts; |
|
| 535 | - $sql_date = date('Y-m-d H:i:s', strtotime($period)); |
|
| 536 | - //prepare the query interval for displaying offset |
|
| 537 | - $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'dates.REG_date'); |
|
| 538 | - //inner date query |
|
| 539 | - $inner_date_query = "SELECT DISTINCT REG_date from {$registration_table} "; |
|
| 540 | - $inner_where = ' WHERE'; |
|
| 541 | - //exclude events not authored by user if permissions in effect |
|
| 542 | - if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) { |
|
| 543 | - $inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID"; |
|
| 544 | - $inner_where .= ' post_author = ' . get_current_user_id() . ' AND'; |
|
| 545 | - } |
|
| 546 | - $inner_where .= " REG_date >= '{$sql_date}'"; |
|
| 547 | - $inner_date_query .= $inner_where; |
|
| 548 | - //start main query |
|
| 549 | - $select = "SELECT DATE({$query_interval}) as Registration_REG_date, "; |
|
| 550 | - $join = ''; |
|
| 551 | - $join_parts = array(); |
|
| 552 | - $select_parts = array(); |
|
| 553 | - //loop through registration stati to do parts for each status. |
|
| 554 | - foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) { |
|
| 555 | - if ($STS_ID === EEM_Registration::status_id_incomplete) { |
|
| 556 | - continue; |
|
| 557 | - } |
|
| 558 | - $select_parts[] = "COUNT({$STS_code}.REG_ID) as {$STS_ID}"; |
|
| 559 | - $join_parts[] = "{$registration_table} AS {$STS_code} ON {$STS_code}.REG_date = dates.REG_date AND {$STS_code}.STS_ID = '{$STS_ID}'"; |
|
| 560 | - } |
|
| 561 | - //setup the selects |
|
| 562 | - $select .= implode(', ', $select_parts); |
|
| 563 | - $select .= " FROM ($inner_date_query) AS dates LEFT JOIN "; |
|
| 564 | - //setup the joins |
|
| 565 | - $join .= implode(' LEFT JOIN ', $join_parts); |
|
| 566 | - //now let's put it all together |
|
| 567 | - $query = $select . $join . ' GROUP BY Registration_REG_date'; |
|
| 568 | - //and execute it |
|
| 569 | - return $wpdb->get_results($query, ARRAY_A); |
|
| 570 | - } |
|
| 571 | - |
|
| 572 | - |
|
| 573 | - /** |
|
| 574 | - * get the number of registrations per event for the Registration Admin page Reports Tab |
|
| 575 | - * |
|
| 576 | - * @access public |
|
| 577 | - * @param $period string which can be passed to php's strtotime function (eg "-1 month") |
|
| 578 | - * @return stdClass[] each with properties event_name, reg_limit, and total |
|
| 579 | - * @throws EE_Error |
|
| 580 | - */ |
|
| 581 | - public function get_registrations_per_event_report($period = '-1 month') |
|
| 582 | - { |
|
| 583 | - $date_sql = $this->convert_datetime_for_query('REG_date', date('Y-m-d H:i:s', strtotime($period)), |
|
| 584 | - 'Y-m-d H:i:s', 'UTC'); |
|
| 585 | - $where = array( |
|
| 586 | - 'REG_date' => array('>=', $date_sql), |
|
| 587 | - 'STS_ID' => array('!=', EEM_Registration::status_id_incomplete), |
|
| 588 | - ); |
|
| 589 | - if ( |
|
| 590 | - !EE_Registry::instance()->CAP->current_user_can( |
|
| 591 | - 'ee_read_others_registrations', |
|
| 592 | - 'reg_per_event_report' |
|
| 593 | - ) |
|
| 594 | - ) { |
|
| 595 | - $where['Event.EVT_wp_user'] = get_current_user_id(); |
|
| 596 | - } |
|
| 597 | - $results = $this->_get_all_wpdb_results(array( |
|
| 598 | - $where, |
|
| 599 | - 'group_by' => 'Event.EVT_name', |
|
| 600 | - 'order_by' => 'Event.EVT_name', |
|
| 601 | - 'limit' => array(0, 24), |
|
| 602 | - ), |
|
| 603 | - OBJECT, |
|
| 604 | - array( |
|
| 605 | - 'event_name' => array('Event_CPT.post_title', '%s'), |
|
| 606 | - 'total' => array('COUNT(REG_ID)', '%s'), |
|
| 607 | - ) |
|
| 608 | - ); |
|
| 609 | - return $results; |
|
| 610 | - } |
|
| 611 | - |
|
| 612 | - |
|
| 613 | - /** |
|
| 614 | - * Get the number of registrations per event grouped by registration status. |
|
| 615 | - * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results. |
|
| 616 | - * |
|
| 617 | - * @param string $period |
|
| 618 | - * @return stdClass[] with properties `Registration_Event` and a column for each registration status as the STS_ID |
|
| 619 | - * @throws EE_Error |
|
| 620 | - * (i.e. RAP) |
|
| 621 | - */ |
|
| 622 | - public function get_registrations_per_event_and_per_status_report($period = '-1 month') |
|
| 623 | - { |
|
| 624 | - global $wpdb; |
|
| 625 | - $registration_table = $wpdb->prefix . 'esp_registration'; |
|
| 626 | - $event_table = $wpdb->posts; |
|
| 627 | - $sql_date = date('Y-m-d H:i:s', strtotime($period)); |
|
| 628 | - //inner date query |
|
| 629 | - $inner_date_query = "SELECT DISTINCT EVT_ID, REG_date from $registration_table "; |
|
| 630 | - $inner_where = ' WHERE'; |
|
| 631 | - //exclude events not authored by user if permissions in effect |
|
| 632 | - if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) { |
|
| 633 | - $inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID"; |
|
| 634 | - $inner_where .= ' post_author = ' . get_current_user_id() . ' AND'; |
|
| 635 | - } |
|
| 636 | - $inner_where .= " REG_date >= '{$sql_date}'"; |
|
| 637 | - $inner_date_query .= $inner_where; |
|
| 638 | - //build main query |
|
| 639 | - $select = 'SELECT Event.post_title as Registration_Event, '; |
|
| 640 | - $join = ''; |
|
| 641 | - $join_parts = array(); |
|
| 642 | - $select_parts = array(); |
|
| 643 | - //loop through registration stati to do parts for each status. |
|
| 644 | - foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) { |
|
| 645 | - if ($STS_ID === EEM_Registration::status_id_incomplete) { |
|
| 646 | - continue; |
|
| 647 | - } |
|
| 648 | - $select_parts[] = "COUNT({$STS_code}.REG_ID) as {$STS_ID}"; |
|
| 649 | - $join_parts[] = "{$registration_table} AS {$STS_code} ON {$STS_code}.EVT_ID = dates.EVT_ID AND {$STS_code}.STS_ID = '{$STS_ID}' AND {$STS_code}.REG_date = dates.REG_date"; |
|
| 650 | - } |
|
| 651 | - //setup the selects |
|
| 652 | - $select .= implode(', ', $select_parts); |
|
| 653 | - $select .= " FROM ($inner_date_query) AS dates LEFT JOIN $event_table as Event ON Event.ID = dates.EVT_ID LEFT JOIN "; |
|
| 654 | - //setup remaining joins |
|
| 655 | - $join .= implode(' LEFT JOIN ', $join_parts); |
|
| 656 | - //now put it all together |
|
| 657 | - $query = $select . $join . ' GROUP BY Registration_Event'; |
|
| 658 | - //and execute |
|
| 659 | - return $wpdb->get_results($query, ARRAY_A); |
|
| 660 | - } |
|
| 661 | - |
|
| 662 | - |
|
| 663 | - /** |
|
| 664 | - * Returns the EE_Registration of the primary attendee on the transaction id provided |
|
| 665 | - * |
|
| 666 | - * @param int $TXN_ID |
|
| 667 | - * @return EE_Base_Class|EE_Registration|null |
|
| 668 | - * @throws EE_Error |
|
| 669 | - */ |
|
| 670 | - public function get_primary_registration_for_transaction_ID($TXN_ID = 0) |
|
| 671 | - { |
|
| 672 | - if (!$TXN_ID) { |
|
| 673 | - return null; |
|
| 674 | - } |
|
| 675 | - return $this->get_one(array( |
|
| 676 | - array( |
|
| 677 | - 'TXN_ID' => $TXN_ID, |
|
| 678 | - 'REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT, |
|
| 679 | - ), |
|
| 680 | - )); |
|
| 681 | - } |
|
| 682 | - |
|
| 683 | - |
|
| 684 | - /** |
|
| 685 | - * get_event_registration_count |
|
| 686 | - * |
|
| 687 | - * @access public |
|
| 688 | - * @param int $EVT_ID |
|
| 689 | - * @param boolean $for_incomplete_payments |
|
| 690 | - * @return int |
|
| 691 | - * @throws EE_Error |
|
| 692 | - */ |
|
| 693 | - public function get_event_registration_count($EVT_ID, $for_incomplete_payments = false) |
|
| 694 | - { |
|
| 695 | - // we only count approved registrations towards registration limits |
|
| 696 | - $query_params = array(array('EVT_ID' => $EVT_ID, 'STS_ID' => self::status_id_approved)); |
|
| 697 | - if ($for_incomplete_payments) { |
|
| 698 | - $query_params[0]['Transaction.STS_ID'] = array('!=', EEM_Transaction::complete_status_code); |
|
| 699 | - } |
|
| 700 | - return $this->count($query_params); |
|
| 701 | - } |
|
| 702 | - |
|
| 703 | - |
|
| 704 | - /** |
|
| 705 | - * Deletes all registrations with no transactions. Note that this needs to be very efficient |
|
| 706 | - * and so it uses wpdb directly |
|
| 707 | - * |
|
| 708 | - * @global WPDB $wpdb |
|
| 709 | - * @return int number deleted |
|
| 710 | - * @throws EE_Error |
|
| 711 | - */ |
|
| 712 | - public function delete_registrations_with_no_transaction() |
|
| 713 | - { |
|
| 714 | - /** @type WPDB $wpdb */ |
|
| 715 | - global $wpdb; |
|
| 716 | - return $wpdb->query( |
|
| 717 | - 'DELETE r FROM ' |
|
| 718 | - . $this->table() |
|
| 719 | - . ' r LEFT JOIN ' |
|
| 720 | - . EEM_Transaction::instance()->table() |
|
| 721 | - . ' t ON r.TXN_ID = t.TXN_ID WHERE t.TXN_ID IS NULL'); |
|
| 722 | - } |
|
| 723 | - |
|
| 724 | - |
|
| 725 | - /** |
|
| 726 | - * Count registrations checked into (or out of) a datetime |
|
| 727 | - * |
|
| 728 | - * @param int $DTT_ID datetime ID |
|
| 729 | - * @param boolean $checked_in whether to count registrations checked IN or OUT |
|
| 730 | - * @return int |
|
| 731 | - * @throws EE_Error |
|
| 732 | - */ |
|
| 733 | - public function count_registrations_checked_into_datetime($DTT_ID, $checked_in = true) |
|
| 734 | - { |
|
| 735 | - global $wpdb; |
|
| 736 | - //subquery to get latest checkin |
|
| 737 | - $query = $wpdb->prepare( |
|
| 738 | - 'SELECT ' |
|
| 739 | - . 'COUNT( DISTINCT checkins.REG_ID ) ' |
|
| 740 | - . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN' |
|
| 741 | - . '( SELECT ' |
|
| 742 | - . 'max( CHK_timestamp ) AS latest_checkin, ' |
|
| 743 | - . 'REG_ID AS REG_ID ' |
|
| 744 | - . 'FROM ' . EEM_Checkin::instance()->table() . ' ' |
|
| 745 | - . 'WHERE DTT_ID=%d ' |
|
| 746 | - . 'GROUP BY REG_ID' |
|
| 747 | - . ') AS most_recent_checkin_per_reg ' |
|
| 748 | - . 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID ' |
|
| 749 | - . 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin ' |
|
| 750 | - . 'WHERE ' |
|
| 751 | - . 'checkins.CHK_in=%d', |
|
| 752 | - $DTT_ID, |
|
| 753 | - $checked_in |
|
| 754 | - ); |
|
| 755 | - return (int)$wpdb->get_var($query); |
|
| 756 | - } |
|
| 757 | - |
|
| 758 | - |
|
| 759 | - /** |
|
| 760 | - * Count registrations checked into (or out of) an event. |
|
| 761 | - * |
|
| 762 | - * @param int $EVT_ID event ID |
|
| 763 | - * @param boolean $checked_in whether to count registrations checked IN or OUT |
|
| 764 | - * @return int |
|
| 765 | - * @throws EE_Error |
|
| 766 | - */ |
|
| 767 | - public function count_registrations_checked_into_event($EVT_ID, $checked_in = true) |
|
| 768 | - { |
|
| 769 | - global $wpdb; |
|
| 770 | - //subquery to get latest checkin |
|
| 771 | - $query = $wpdb->prepare( |
|
| 772 | - 'SELECT ' |
|
| 773 | - . 'COUNT( DISTINCT checkins.REG_ID ) ' |
|
| 774 | - . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN' |
|
| 775 | - . '( SELECT ' |
|
| 776 | - . 'max( CHK_timestamp ) AS latest_checkin, ' |
|
| 777 | - . 'REG_ID AS REG_ID ' |
|
| 778 | - . 'FROM ' . EEM_Checkin::instance()->table() . ' AS c ' |
|
| 779 | - . 'INNER JOIN ' . EEM_Datetime::instance()->table() . ' AS d ' |
|
| 780 | - . 'ON c.DTT_ID=d.DTT_ID ' |
|
| 781 | - . 'WHERE d.EVT_ID=%d ' |
|
| 782 | - . 'GROUP BY REG_ID' |
|
| 783 | - . ') AS most_recent_checkin_per_reg ' |
|
| 784 | - . 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID ' |
|
| 785 | - . 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin ' |
|
| 786 | - . 'WHERE ' |
|
| 787 | - . 'checkins.CHK_in=%d', |
|
| 788 | - $EVT_ID, |
|
| 789 | - $checked_in |
|
| 790 | - ); |
|
| 791 | - return (int)$wpdb->get_var($query); |
|
| 792 | - } |
|
| 793 | - |
|
| 794 | - |
|
| 795 | - /** |
|
| 796 | - * The purpose of this method is to retrieve an array of |
|
| 797 | - * EE_Registration objects that represent the latest registration |
|
| 798 | - * for each ATT_ID given in the function argument. |
|
| 799 | - * |
|
| 800 | - * @param array $attendee_ids |
|
| 801 | - * @return EE_Base_Class[]|EE_Registration[] |
|
| 802 | - * @throws EE_Error |
|
| 803 | - */ |
|
| 804 | - public function get_latest_registration_for_each_of_given_contacts($attendee_ids = array()) |
|
| 805 | - { |
|
| 806 | - //first do a native wp_query to get the latest REG_ID's matching these attendees. |
|
| 807 | - global $wpdb; |
|
| 808 | - $registration_table = $wpdb->prefix . 'esp_registration'; |
|
| 809 | - $attendee_table = $wpdb->posts; |
|
| 810 | - $attendee_ids = is_array($attendee_ids) |
|
| 811 | - ? array_map('absint', $attendee_ids) |
|
| 812 | - : array((int)$attendee_ids); |
|
| 813 | - $ATT_IDs = implode(',', $attendee_ids); |
|
| 814 | - // first we do a query to get the registration ids |
|
| 815 | - // (because a group by before order by causes the order by to be ignored.) |
|
| 816 | - $registration_id_query = " |
|
| 21 | + /** |
|
| 22 | + * @var EEM_Registration $_instance |
|
| 23 | + */ |
|
| 24 | + protected static $_instance; |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * Keys are the status IDs for registrations (eg, RAP, RCN, etc), and the values |
|
| 28 | + * are status codes (eg, approved, cancelled, etc) |
|
| 29 | + * |
|
| 30 | + * @var array |
|
| 31 | + */ |
|
| 32 | + private static $_reg_status; |
|
| 33 | + |
|
| 34 | + /** |
|
| 35 | + * The value of REG_count for a primary registrant |
|
| 36 | + */ |
|
| 37 | + const PRIMARY_REGISTRANT_COUNT = 1; |
|
| 38 | + |
|
| 39 | + /** |
|
| 40 | + * Status ID (STS_ID on esp_status table) to indicate an INCOMPLETE registration. |
|
| 41 | + * Initial status for registrations when they are first created |
|
| 42 | + * Payments are NOT allowed. |
|
| 43 | + * Automatically toggled to whatever the default Event registration status is upon completion of the attendee |
|
| 44 | + * information reg step NO space reserved. Registration is NOT active |
|
| 45 | + */ |
|
| 46 | + const status_id_incomplete = 'RIC'; |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * Status ID (STS_ID on esp_status table) to indicate an UNAPPROVED registration. |
|
| 50 | + * Payments are NOT allowed. |
|
| 51 | + * Event Admin must manually toggle STS_ID for it to change |
|
| 52 | + * No space reserved. |
|
| 53 | + * Registration is active |
|
| 54 | + */ |
|
| 55 | + const status_id_not_approved = 'RNA'; |
|
| 56 | + |
|
| 57 | + /** |
|
| 58 | + * Status ID (STS_ID on esp_status table) to indicate registration is PENDING_PAYMENT . |
|
| 59 | + * Payments are allowed. |
|
| 60 | + * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee |
|
| 61 | + * No space reserved. |
|
| 62 | + * Registration is active |
|
| 63 | + */ |
|
| 64 | + const status_id_pending_payment = 'RPP'; |
|
| 65 | + |
|
| 66 | + /** |
|
| 67 | + * Status ID (STS_ID on esp_status table) to indicate registration is on the WAIT_LIST . |
|
| 68 | + * Payments are allowed. |
|
| 69 | + * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee |
|
| 70 | + * No space reserved. |
|
| 71 | + * Registration is active |
|
| 72 | + */ |
|
| 73 | + const status_id_wait_list = 'RWL'; |
|
| 74 | + |
|
| 75 | + /** |
|
| 76 | + * Status ID (STS_ID on esp_status table) to indicate an APPROVED registration. |
|
| 77 | + * the TXN may or may not be completed ( paid in full ) |
|
| 78 | + * Payments are allowed. |
|
| 79 | + * A space IS reserved. |
|
| 80 | + * Registration is active |
|
| 81 | + */ |
|
| 82 | + const status_id_approved = 'RAP'; |
|
| 83 | + |
|
| 84 | + /** |
|
| 85 | + * Status ID (STS_ID on esp_status table) to indicate a registration was CANCELLED by the attendee. |
|
| 86 | + * Payments are NOT allowed. |
|
| 87 | + * NO space reserved. |
|
| 88 | + * Registration is NOT active |
|
| 89 | + */ |
|
| 90 | + const status_id_cancelled = 'RCN'; |
|
| 91 | + |
|
| 92 | + /** |
|
| 93 | + * Status ID (STS_ID on esp_status table) to indicate a registration was DECLINED by the Event Admin |
|
| 94 | + * Payments are NOT allowed. |
|
| 95 | + * No space reserved. |
|
| 96 | + * Registration is NOT active |
|
| 97 | + */ |
|
| 98 | + const status_id_declined = 'RDC'; |
|
| 99 | + |
|
| 100 | + /** |
|
| 101 | + * @var TableAnalysis $table_analysis |
|
| 102 | + */ |
|
| 103 | + protected $_table_analysis; |
|
| 104 | + |
|
| 105 | + |
|
| 106 | + /** |
|
| 107 | + * private constructor to prevent direct creation |
|
| 108 | + * |
|
| 109 | + * @Constructor |
|
| 110 | + * @access protected |
|
| 111 | + * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any |
|
| 112 | + * incoming timezone data that gets saved). Note this just sends the timezone info to the |
|
| 113 | + * date time model field objects. Default is NULL (and will be assumed using the set |
|
| 114 | + * timezone in the 'timezone_string' wp option) |
|
| 115 | + * @throws EE_Error |
|
| 116 | + */ |
|
| 117 | + protected function __construct($timezone = null) |
|
| 118 | + { |
|
| 119 | + $this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true); |
|
| 120 | + $this->singular_item = esc_html__('Registration', 'event_espresso'); |
|
| 121 | + $this->plural_item = esc_html__('Registrations', 'event_espresso'); |
|
| 122 | + $this->_tables = array( |
|
| 123 | + 'Registration' => new EE_Primary_Table('esp_registration', 'REG_ID'), |
|
| 124 | + ); |
|
| 125 | + $this->_fields = array( |
|
| 126 | + 'Registration' => array( |
|
| 127 | + 'REG_ID' => new EE_Primary_Key_Int_Field( |
|
| 128 | + 'REG_ID', |
|
| 129 | + esc_html__('Registration ID', 'event_espresso') |
|
| 130 | + ), |
|
| 131 | + 'EVT_ID' => new EE_Foreign_Key_Int_Field( |
|
| 132 | + 'EVT_ID', |
|
| 133 | + esc_html__('Event ID', 'event_espresso'), |
|
| 134 | + false, |
|
| 135 | + 0, |
|
| 136 | + 'Event' |
|
| 137 | + ), |
|
| 138 | + 'ATT_ID' => new EE_Foreign_Key_Int_Field( |
|
| 139 | + 'ATT_ID', |
|
| 140 | + esc_html__('Attendee ID', 'event_espresso'), |
|
| 141 | + false, |
|
| 142 | + 0, |
|
| 143 | + 'Attendee' |
|
| 144 | + ), |
|
| 145 | + 'TXN_ID' => new EE_Foreign_Key_Int_Field( |
|
| 146 | + 'TXN_ID', |
|
| 147 | + esc_html__('Transaction ID', 'event_espresso'), |
|
| 148 | + false, 0, 'Transaction' |
|
| 149 | + ), |
|
| 150 | + 'TKT_ID' => new EE_Foreign_Key_Int_Field( |
|
| 151 | + 'TKT_ID', |
|
| 152 | + esc_html__('Ticket ID', 'event_espresso'), |
|
| 153 | + false, |
|
| 154 | + 0, 'Ticket' |
|
| 155 | + ), |
|
| 156 | + 'STS_ID' => new EE_Foreign_Key_String_Field( |
|
| 157 | + 'STS_ID', |
|
| 158 | + esc_html__('Status ID', 'event_espresso'), |
|
| 159 | + false, |
|
| 160 | + EEM_Registration::status_id_incomplete, |
|
| 161 | + 'Status' |
|
| 162 | + ), |
|
| 163 | + 'REG_date' => new EE_Datetime_Field( |
|
| 164 | + 'REG_date', |
|
| 165 | + esc_html__('Time registration occurred', 'event_espresso'), |
|
| 166 | + false, |
|
| 167 | + EE_Datetime_Field::now, |
|
| 168 | + $timezone |
|
| 169 | + ), |
|
| 170 | + 'REG_final_price' => new EE_Money_Field( |
|
| 171 | + 'REG_final_price', |
|
| 172 | + esc_html__('Registration\'s share of the transaction total', 'event_espresso'), |
|
| 173 | + false, |
|
| 174 | + 0 |
|
| 175 | + ), |
|
| 176 | + 'REG_paid' => new EE_Money_Field( |
|
| 177 | + 'REG_paid', |
|
| 178 | + esc_html__('Amount paid to date towards registration', 'event_espresso'), |
|
| 179 | + false, |
|
| 180 | + 0 |
|
| 181 | + ), |
|
| 182 | + 'REG_session' => new EE_Plain_Text_Field( |
|
| 183 | + 'REG_session', |
|
| 184 | + esc_html__('Session ID of registration', 'event_espresso'), |
|
| 185 | + false, |
|
| 186 | + '' |
|
| 187 | + ), |
|
| 188 | + 'REG_code' => new EE_Plain_Text_Field( |
|
| 189 | + 'REG_code', |
|
| 190 | + esc_html__('Unique Code for this registration', 'event_espresso'), |
|
| 191 | + false, |
|
| 192 | + '' |
|
| 193 | + ), |
|
| 194 | + 'REG_url_link' => new EE_Plain_Text_Field( |
|
| 195 | + 'REG_url_link', |
|
| 196 | + esc_html__('String to be used in URL for identifying registration', 'event_espresso'), |
|
| 197 | + false, |
|
| 198 | + '' |
|
| 199 | + ), |
|
| 200 | + 'REG_count' => new EE_Integer_Field( |
|
| 201 | + 'REG_count', |
|
| 202 | + esc_html__('Count of this registration in the group registration ', 'event_espresso'), |
|
| 203 | + true, |
|
| 204 | + 1 |
|
| 205 | + ), |
|
| 206 | + 'REG_group_size' => new EE_Integer_Field( |
|
| 207 | + 'REG_group_size', |
|
| 208 | + esc_html__('Number of registrations on this group', 'event_espresso'), |
|
| 209 | + false, |
|
| 210 | + 1 |
|
| 211 | + ), |
|
| 212 | + 'REG_att_is_going' => new EE_Boolean_Field( |
|
| 213 | + 'REG_att_is_going', |
|
| 214 | + esc_html__('Flag indicating the registrant plans on attending', 'event_espresso'), |
|
| 215 | + false, |
|
| 216 | + false |
|
| 217 | + ), |
|
| 218 | + 'REG_deleted' => new EE_Trashed_Flag_Field( |
|
| 219 | + 'REG_deleted', |
|
| 220 | + esc_html__('Flag indicating if registration has been archived or not.', 'event_espresso'), |
|
| 221 | + false, |
|
| 222 | + false |
|
| 223 | + ), |
|
| 224 | + ), |
|
| 225 | + ); |
|
| 226 | + $this->_model_relations = array( |
|
| 227 | + 'Event' => new EE_Belongs_To_Relation(), |
|
| 228 | + 'Attendee' => new EE_Belongs_To_Relation(), |
|
| 229 | + 'Transaction' => new EE_Belongs_To_Relation(), |
|
| 230 | + 'Ticket' => new EE_Belongs_To_Relation(), |
|
| 231 | + 'Status' => new EE_Belongs_To_Relation(), |
|
| 232 | + 'Answer' => new EE_Has_Many_Relation(), |
|
| 233 | + 'Checkin' => new EE_Has_Many_Relation(), |
|
| 234 | + 'Registration_Payment' => new EE_Has_Many_Relation(), |
|
| 235 | + 'Payment' => new EE_HABTM_Relation('Registration_Payment'), |
|
| 236 | + 'Message' => new EE_Has_Many_Any_Relation(false) |
|
| 237 | + //allow deletes even if there are messages in the queue related |
|
| 238 | + ); |
|
| 239 | + $this->_model_chain_to_wp_user = 'Event'; |
|
| 240 | + parent::__construct($timezone); |
|
| 241 | + } |
|
| 242 | + |
|
| 243 | + |
|
| 244 | + /** |
|
| 245 | + * a list of ALL valid registration statuses currently in use within the system |
|
| 246 | + * generated by combining the filterable active and inactive reg status arrays |
|
| 247 | + * |
|
| 248 | + * @return array |
|
| 249 | + */ |
|
| 250 | + public static function reg_statuses() |
|
| 251 | + { |
|
| 252 | + return array_unique( |
|
| 253 | + array_merge( |
|
| 254 | + EEM_Registration::active_reg_statuses(), |
|
| 255 | + EEM_Registration::inactive_reg_statuses() |
|
| 256 | + ) |
|
| 257 | + ); |
|
| 258 | + } |
|
| 259 | + |
|
| 260 | + |
|
| 261 | + /** |
|
| 262 | + * reg_statuses_that_allow_payment |
|
| 263 | + * a filterable list of registration statuses that allow a registrant to make a payment |
|
| 264 | + * |
|
| 265 | + * @access public |
|
| 266 | + * @return array |
|
| 267 | + */ |
|
| 268 | + public static function reg_statuses_that_allow_payment() |
|
| 269 | + { |
|
| 270 | + return apply_filters( |
|
| 271 | + 'FHEE__EEM_Registration__reg_statuses_that_allow_payment', |
|
| 272 | + array( |
|
| 273 | + EEM_Registration::status_id_approved, |
|
| 274 | + EEM_Registration::status_id_pending_payment, |
|
| 275 | + ) |
|
| 276 | + ); |
|
| 277 | + } |
|
| 278 | + |
|
| 279 | + |
|
| 280 | + /** |
|
| 281 | + * active_reg_statuses |
|
| 282 | + * a filterable list of registration statuses that are considered active |
|
| 283 | + * |
|
| 284 | + * @access public |
|
| 285 | + * @return array |
|
| 286 | + */ |
|
| 287 | + public static function active_reg_statuses() |
|
| 288 | + { |
|
| 289 | + return apply_filters( |
|
| 290 | + 'FHEE__EEM_Registration__active_reg_statuses', |
|
| 291 | + array( |
|
| 292 | + EEM_Registration::status_id_approved, |
|
| 293 | + EEM_Registration::status_id_pending_payment, |
|
| 294 | + EEM_Registration::status_id_wait_list, |
|
| 295 | + EEM_Registration::status_id_not_approved, |
|
| 296 | + ) |
|
| 297 | + ); |
|
| 298 | + } |
|
| 299 | + |
|
| 300 | + |
|
| 301 | + /** |
|
| 302 | + * inactive_reg_statuses |
|
| 303 | + * a filterable list of registration statuses that are not considered active |
|
| 304 | + * |
|
| 305 | + * @access public |
|
| 306 | + * @return array |
|
| 307 | + */ |
|
| 308 | + public static function inactive_reg_statuses() |
|
| 309 | + { |
|
| 310 | + return apply_filters( |
|
| 311 | + 'FHEE__EEM_Registration__inactive_reg_statuses', |
|
| 312 | + array( |
|
| 313 | + EEM_Registration::status_id_incomplete, |
|
| 314 | + EEM_Registration::status_id_cancelled, |
|
| 315 | + EEM_Registration::status_id_declined, |
|
| 316 | + ) |
|
| 317 | + ); |
|
| 318 | + } |
|
| 319 | + |
|
| 320 | + |
|
| 321 | + /** |
|
| 322 | + * closed_reg_statuses |
|
| 323 | + * a filterable list of registration statuses that are considered "closed" |
|
| 324 | + * meaning they should not be considered in any calculations involving monies owing |
|
| 325 | + * |
|
| 326 | + * @access public |
|
| 327 | + * @return array |
|
| 328 | + */ |
|
| 329 | + public static function closed_reg_statuses() |
|
| 330 | + { |
|
| 331 | + return apply_filters( |
|
| 332 | + 'FHEE__EEM_Registration__closed_reg_statuses', |
|
| 333 | + array( |
|
| 334 | + EEM_Registration::status_id_cancelled, |
|
| 335 | + EEM_Registration::status_id_declined, |
|
| 336 | + EEM_Registration::status_id_wait_list, |
|
| 337 | + ) |
|
| 338 | + ); |
|
| 339 | + } |
|
| 340 | + |
|
| 341 | + |
|
| 342 | + /** |
|
| 343 | + * get list of registration statuses |
|
| 344 | + * |
|
| 345 | + * @access public |
|
| 346 | + * @param array $exclude The status ids to exclude from the returned results |
|
| 347 | + * @param bool $translated If true will return the values as singular localized strings |
|
| 348 | + * @return array |
|
| 349 | + * @throws EE_Error |
|
| 350 | + */ |
|
| 351 | + public static function reg_status_array($exclude = array(), $translated = false) |
|
| 352 | + { |
|
| 353 | + EEM_Registration::instance()->_get_registration_status_array($exclude); |
|
| 354 | + return $translated |
|
| 355 | + ? EEM_Status::instance()->localized_status(self::$_reg_status, false, 'sentence') |
|
| 356 | + : self::$_reg_status; |
|
| 357 | + } |
|
| 358 | + |
|
| 359 | + |
|
| 360 | + /** |
|
| 361 | + * get list of registration statuses |
|
| 362 | + * |
|
| 363 | + * @access private |
|
| 364 | + * @param array $exclude |
|
| 365 | + * @return void |
|
| 366 | + * @throws EE_Error |
|
| 367 | + */ |
|
| 368 | + private function _get_registration_status_array($exclude = array()) |
|
| 369 | + { |
|
| 370 | + //in the very rare circumstance that we are deleting a model's table's data |
|
| 371 | + //and the table hasn't actually been created, this could have an error |
|
| 372 | + /** @type WPDB $wpdb */ |
|
| 373 | + global $wpdb; |
|
| 374 | + if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) { |
|
| 375 | + $results = $wpdb->get_results( |
|
| 376 | + "SELECT STS_ID, STS_code FROM {$wpdb->prefix}esp_status WHERE STS_type = 'registration'" |
|
| 377 | + ); |
|
| 378 | + self::$_reg_status = array(); |
|
| 379 | + foreach ($results as $status) { |
|
| 380 | + if (!in_array($status->STS_ID, $exclude, true)) { |
|
| 381 | + self::$_reg_status[$status->STS_ID] = $status->STS_code; |
|
| 382 | + } |
|
| 383 | + } |
|
| 384 | + } |
|
| 385 | + } |
|
| 386 | + |
|
| 387 | + |
|
| 388 | + /** |
|
| 389 | + * Gets the injected table analyzer, or throws an exception |
|
| 390 | + * |
|
| 391 | + * @return TableAnalysis |
|
| 392 | + * @throws EE_Error |
|
| 393 | + */ |
|
| 394 | + protected function _get_table_analysis() |
|
| 395 | + { |
|
| 396 | + if ($this->_table_analysis instanceof TableAnalysis) { |
|
| 397 | + return $this->_table_analysis; |
|
| 398 | + } |
|
| 399 | + throw new EE_Error( |
|
| 400 | + sprintf( |
|
| 401 | + esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'), |
|
| 402 | + get_class($this) |
|
| 403 | + ) |
|
| 404 | + ); |
|
| 405 | + } |
|
| 406 | + |
|
| 407 | + |
|
| 408 | + /** |
|
| 409 | + * This returns a wpdb->results array of all registration date month and years matching the incoming query params |
|
| 410 | + * and grouped by month and year. |
|
| 411 | + * |
|
| 412 | + * @param array $where_params Array of query_params as described in the comments for EEM_Base::get_all() |
|
| 413 | + * @return array |
|
| 414 | + * @throws EE_Error |
|
| 415 | + */ |
|
| 416 | + public function get_reg_months_and_years($where_params) |
|
| 417 | + { |
|
| 418 | + $query_params[0] = $where_params; |
|
| 419 | + $query_params['group_by'] = array('reg_year', 'reg_month'); |
|
| 420 | + $query_params['order_by'] = array('REG_date' => 'DESC'); |
|
| 421 | + $columns_to_select = array( |
|
| 422 | + 'reg_year' => array('YEAR(REG_date)', '%s'), |
|
| 423 | + 'reg_month' => array('MONTHNAME(REG_date)', '%s'), |
|
| 424 | + ); |
|
| 425 | + return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select); |
|
| 426 | + } |
|
| 427 | + |
|
| 428 | + |
|
| 429 | + /** |
|
| 430 | + * retrieve ALL registrations for a particular Attendee from db |
|
| 431 | + * |
|
| 432 | + * @param int $ATT_ID |
|
| 433 | + * @return EE_Base_Class[]|EE_Registration[]|null |
|
| 434 | + * @throws EE_Error |
|
| 435 | + */ |
|
| 436 | + public function get_all_registrations_for_attendee($ATT_ID = 0) |
|
| 437 | + { |
|
| 438 | + if (!$ATT_ID) { |
|
| 439 | + return null; |
|
| 440 | + } |
|
| 441 | + return $this->get_all(array(array('ATT_ID' => $ATT_ID))); |
|
| 442 | + } |
|
| 443 | + |
|
| 444 | + |
|
| 445 | + /** |
|
| 446 | + * Gets a registration given their REG_url_link. Yes, this should usually |
|
| 447 | + * be passed via a GET parameter. |
|
| 448 | + * |
|
| 449 | + * @param string $REG_url_link |
|
| 450 | + * @return EE_Base_Class|EE_Registration|null |
|
| 451 | + * @throws EE_Error |
|
| 452 | + */ |
|
| 453 | + public function get_registration_for_reg_url_link($REG_url_link) |
|
| 454 | + { |
|
| 455 | + if (!$REG_url_link) { |
|
| 456 | + return null; |
|
| 457 | + } |
|
| 458 | + return $this->get_one(array(array('REG_url_link' => $REG_url_link))); |
|
| 459 | + } |
|
| 460 | + |
|
| 461 | + |
|
| 462 | + /** |
|
| 463 | + * retrieve registration for a specific transaction attendee from db |
|
| 464 | + * |
|
| 465 | + * @access public |
|
| 466 | + * @param int $TXN_ID |
|
| 467 | + * @param int $ATT_ID |
|
| 468 | + * @param int $att_nmbr in case the ATT_ID is the same for multiple registrations (same details used) then the |
|
| 469 | + * attendee number is required |
|
| 470 | + * @return mixed array on success, FALSE on fail |
|
| 471 | + * @throws EE_Error |
|
| 472 | + */ |
|
| 473 | + public function get_registration_for_transaction_attendee($TXN_ID = 0, $ATT_ID = 0, $att_nmbr = 0) |
|
| 474 | + { |
|
| 475 | + return $this->get_one(array( |
|
| 476 | + array( |
|
| 477 | + 'TXN_ID' => $TXN_ID, |
|
| 478 | + 'ATT_ID' => $ATT_ID, |
|
| 479 | + ), |
|
| 480 | + 'limit' => array(min($att_nmbr - 1, 0), 1), |
|
| 481 | + )); |
|
| 482 | + } |
|
| 483 | + |
|
| 484 | + |
|
| 485 | + /** |
|
| 486 | + * get the number of registrations per day for the Registration Admin page Reports Tab. |
|
| 487 | + * (doesn't utilize models because it's a fairly specialized query) |
|
| 488 | + * |
|
| 489 | + * @access public |
|
| 490 | + * @param $period string which can be passed to php's strtotime function (eg "-1 month") |
|
| 491 | + * @return stdClass[] with properties regDate and total |
|
| 492 | + * @throws EE_Error |
|
| 493 | + */ |
|
| 494 | + public function get_registrations_per_day_report($period = '-1 month') |
|
| 495 | + { |
|
| 496 | + $sql_date = $this->convert_datetime_for_query('REG_date', date('Y-m-d H:i:s', strtotime($period)), |
|
| 497 | + 'Y-m-d H:i:s', 'UTC'); |
|
| 498 | + $where = array( |
|
| 499 | + 'REG_date' => array('>=', $sql_date), |
|
| 500 | + 'STS_ID' => array('!=', EEM_Registration::status_id_incomplete), |
|
| 501 | + ); |
|
| 502 | + if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) { |
|
| 503 | + $where['Event.EVT_wp_user'] = get_current_user_id(); |
|
| 504 | + } |
|
| 505 | + $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'REG_date'); |
|
| 506 | + $results = $this->_get_all_wpdb_results( |
|
| 507 | + array( |
|
| 508 | + $where, |
|
| 509 | + 'group_by' => 'regDate', |
|
| 510 | + 'order_by' => array('REG_date' => 'ASC'), |
|
| 511 | + ), |
|
| 512 | + OBJECT, |
|
| 513 | + array( |
|
| 514 | + 'regDate' => array('DATE(' . $query_interval . ')', '%s'), |
|
| 515 | + 'total' => array('count(REG_ID)', '%d'), |
|
| 516 | + )); |
|
| 517 | + return $results; |
|
| 518 | + } |
|
| 519 | + |
|
| 520 | + |
|
| 521 | + /** |
|
| 522 | + * Get the number of registrations per day including the count of registrations for each Registration Status. |
|
| 523 | + * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results. |
|
| 524 | + * |
|
| 525 | + * @param string $period |
|
| 526 | + * @return stdClass[] with properties Registration_REG_date and a column for each registration status as the STS_ID |
|
| 527 | + * @throws EE_Error |
|
| 528 | + * (i.e. RAP) |
|
| 529 | + */ |
|
| 530 | + public function get_registrations_per_day_and_per_status_report($period = '-1 month') |
|
| 531 | + { |
|
| 532 | + global $wpdb; |
|
| 533 | + $registration_table = $wpdb->prefix . 'esp_registration'; |
|
| 534 | + $event_table = $wpdb->posts; |
|
| 535 | + $sql_date = date('Y-m-d H:i:s', strtotime($period)); |
|
| 536 | + //prepare the query interval for displaying offset |
|
| 537 | + $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'dates.REG_date'); |
|
| 538 | + //inner date query |
|
| 539 | + $inner_date_query = "SELECT DISTINCT REG_date from {$registration_table} "; |
|
| 540 | + $inner_where = ' WHERE'; |
|
| 541 | + //exclude events not authored by user if permissions in effect |
|
| 542 | + if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) { |
|
| 543 | + $inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID"; |
|
| 544 | + $inner_where .= ' post_author = ' . get_current_user_id() . ' AND'; |
|
| 545 | + } |
|
| 546 | + $inner_where .= " REG_date >= '{$sql_date}'"; |
|
| 547 | + $inner_date_query .= $inner_where; |
|
| 548 | + //start main query |
|
| 549 | + $select = "SELECT DATE({$query_interval}) as Registration_REG_date, "; |
|
| 550 | + $join = ''; |
|
| 551 | + $join_parts = array(); |
|
| 552 | + $select_parts = array(); |
|
| 553 | + //loop through registration stati to do parts for each status. |
|
| 554 | + foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) { |
|
| 555 | + if ($STS_ID === EEM_Registration::status_id_incomplete) { |
|
| 556 | + continue; |
|
| 557 | + } |
|
| 558 | + $select_parts[] = "COUNT({$STS_code}.REG_ID) as {$STS_ID}"; |
|
| 559 | + $join_parts[] = "{$registration_table} AS {$STS_code} ON {$STS_code}.REG_date = dates.REG_date AND {$STS_code}.STS_ID = '{$STS_ID}'"; |
|
| 560 | + } |
|
| 561 | + //setup the selects |
|
| 562 | + $select .= implode(', ', $select_parts); |
|
| 563 | + $select .= " FROM ($inner_date_query) AS dates LEFT JOIN "; |
|
| 564 | + //setup the joins |
|
| 565 | + $join .= implode(' LEFT JOIN ', $join_parts); |
|
| 566 | + //now let's put it all together |
|
| 567 | + $query = $select . $join . ' GROUP BY Registration_REG_date'; |
|
| 568 | + //and execute it |
|
| 569 | + return $wpdb->get_results($query, ARRAY_A); |
|
| 570 | + } |
|
| 571 | + |
|
| 572 | + |
|
| 573 | + /** |
|
| 574 | + * get the number of registrations per event for the Registration Admin page Reports Tab |
|
| 575 | + * |
|
| 576 | + * @access public |
|
| 577 | + * @param $period string which can be passed to php's strtotime function (eg "-1 month") |
|
| 578 | + * @return stdClass[] each with properties event_name, reg_limit, and total |
|
| 579 | + * @throws EE_Error |
|
| 580 | + */ |
|
| 581 | + public function get_registrations_per_event_report($period = '-1 month') |
|
| 582 | + { |
|
| 583 | + $date_sql = $this->convert_datetime_for_query('REG_date', date('Y-m-d H:i:s', strtotime($period)), |
|
| 584 | + 'Y-m-d H:i:s', 'UTC'); |
|
| 585 | + $where = array( |
|
| 586 | + 'REG_date' => array('>=', $date_sql), |
|
| 587 | + 'STS_ID' => array('!=', EEM_Registration::status_id_incomplete), |
|
| 588 | + ); |
|
| 589 | + if ( |
|
| 590 | + !EE_Registry::instance()->CAP->current_user_can( |
|
| 591 | + 'ee_read_others_registrations', |
|
| 592 | + 'reg_per_event_report' |
|
| 593 | + ) |
|
| 594 | + ) { |
|
| 595 | + $where['Event.EVT_wp_user'] = get_current_user_id(); |
|
| 596 | + } |
|
| 597 | + $results = $this->_get_all_wpdb_results(array( |
|
| 598 | + $where, |
|
| 599 | + 'group_by' => 'Event.EVT_name', |
|
| 600 | + 'order_by' => 'Event.EVT_name', |
|
| 601 | + 'limit' => array(0, 24), |
|
| 602 | + ), |
|
| 603 | + OBJECT, |
|
| 604 | + array( |
|
| 605 | + 'event_name' => array('Event_CPT.post_title', '%s'), |
|
| 606 | + 'total' => array('COUNT(REG_ID)', '%s'), |
|
| 607 | + ) |
|
| 608 | + ); |
|
| 609 | + return $results; |
|
| 610 | + } |
|
| 611 | + |
|
| 612 | + |
|
| 613 | + /** |
|
| 614 | + * Get the number of registrations per event grouped by registration status. |
|
| 615 | + * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results. |
|
| 616 | + * |
|
| 617 | + * @param string $period |
|
| 618 | + * @return stdClass[] with properties `Registration_Event` and a column for each registration status as the STS_ID |
|
| 619 | + * @throws EE_Error |
|
| 620 | + * (i.e. RAP) |
|
| 621 | + */ |
|
| 622 | + public function get_registrations_per_event_and_per_status_report($period = '-1 month') |
|
| 623 | + { |
|
| 624 | + global $wpdb; |
|
| 625 | + $registration_table = $wpdb->prefix . 'esp_registration'; |
|
| 626 | + $event_table = $wpdb->posts; |
|
| 627 | + $sql_date = date('Y-m-d H:i:s', strtotime($period)); |
|
| 628 | + //inner date query |
|
| 629 | + $inner_date_query = "SELECT DISTINCT EVT_ID, REG_date from $registration_table "; |
|
| 630 | + $inner_where = ' WHERE'; |
|
| 631 | + //exclude events not authored by user if permissions in effect |
|
| 632 | + if (!EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) { |
|
| 633 | + $inner_date_query .= "LEFT JOIN {$event_table} ON ID = EVT_ID"; |
|
| 634 | + $inner_where .= ' post_author = ' . get_current_user_id() . ' AND'; |
|
| 635 | + } |
|
| 636 | + $inner_where .= " REG_date >= '{$sql_date}'"; |
|
| 637 | + $inner_date_query .= $inner_where; |
|
| 638 | + //build main query |
|
| 639 | + $select = 'SELECT Event.post_title as Registration_Event, '; |
|
| 640 | + $join = ''; |
|
| 641 | + $join_parts = array(); |
|
| 642 | + $select_parts = array(); |
|
| 643 | + //loop through registration stati to do parts for each status. |
|
| 644 | + foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) { |
|
| 645 | + if ($STS_ID === EEM_Registration::status_id_incomplete) { |
|
| 646 | + continue; |
|
| 647 | + } |
|
| 648 | + $select_parts[] = "COUNT({$STS_code}.REG_ID) as {$STS_ID}"; |
|
| 649 | + $join_parts[] = "{$registration_table} AS {$STS_code} ON {$STS_code}.EVT_ID = dates.EVT_ID AND {$STS_code}.STS_ID = '{$STS_ID}' AND {$STS_code}.REG_date = dates.REG_date"; |
|
| 650 | + } |
|
| 651 | + //setup the selects |
|
| 652 | + $select .= implode(', ', $select_parts); |
|
| 653 | + $select .= " FROM ($inner_date_query) AS dates LEFT JOIN $event_table as Event ON Event.ID = dates.EVT_ID LEFT JOIN "; |
|
| 654 | + //setup remaining joins |
|
| 655 | + $join .= implode(' LEFT JOIN ', $join_parts); |
|
| 656 | + //now put it all together |
|
| 657 | + $query = $select . $join . ' GROUP BY Registration_Event'; |
|
| 658 | + //and execute |
|
| 659 | + return $wpdb->get_results($query, ARRAY_A); |
|
| 660 | + } |
|
| 661 | + |
|
| 662 | + |
|
| 663 | + /** |
|
| 664 | + * Returns the EE_Registration of the primary attendee on the transaction id provided |
|
| 665 | + * |
|
| 666 | + * @param int $TXN_ID |
|
| 667 | + * @return EE_Base_Class|EE_Registration|null |
|
| 668 | + * @throws EE_Error |
|
| 669 | + */ |
|
| 670 | + public function get_primary_registration_for_transaction_ID($TXN_ID = 0) |
|
| 671 | + { |
|
| 672 | + if (!$TXN_ID) { |
|
| 673 | + return null; |
|
| 674 | + } |
|
| 675 | + return $this->get_one(array( |
|
| 676 | + array( |
|
| 677 | + 'TXN_ID' => $TXN_ID, |
|
| 678 | + 'REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT, |
|
| 679 | + ), |
|
| 680 | + )); |
|
| 681 | + } |
|
| 682 | + |
|
| 683 | + |
|
| 684 | + /** |
|
| 685 | + * get_event_registration_count |
|
| 686 | + * |
|
| 687 | + * @access public |
|
| 688 | + * @param int $EVT_ID |
|
| 689 | + * @param boolean $for_incomplete_payments |
|
| 690 | + * @return int |
|
| 691 | + * @throws EE_Error |
|
| 692 | + */ |
|
| 693 | + public function get_event_registration_count($EVT_ID, $for_incomplete_payments = false) |
|
| 694 | + { |
|
| 695 | + // we only count approved registrations towards registration limits |
|
| 696 | + $query_params = array(array('EVT_ID' => $EVT_ID, 'STS_ID' => self::status_id_approved)); |
|
| 697 | + if ($for_incomplete_payments) { |
|
| 698 | + $query_params[0]['Transaction.STS_ID'] = array('!=', EEM_Transaction::complete_status_code); |
|
| 699 | + } |
|
| 700 | + return $this->count($query_params); |
|
| 701 | + } |
|
| 702 | + |
|
| 703 | + |
|
| 704 | + /** |
|
| 705 | + * Deletes all registrations with no transactions. Note that this needs to be very efficient |
|
| 706 | + * and so it uses wpdb directly |
|
| 707 | + * |
|
| 708 | + * @global WPDB $wpdb |
|
| 709 | + * @return int number deleted |
|
| 710 | + * @throws EE_Error |
|
| 711 | + */ |
|
| 712 | + public function delete_registrations_with_no_transaction() |
|
| 713 | + { |
|
| 714 | + /** @type WPDB $wpdb */ |
|
| 715 | + global $wpdb; |
|
| 716 | + return $wpdb->query( |
|
| 717 | + 'DELETE r FROM ' |
|
| 718 | + . $this->table() |
|
| 719 | + . ' r LEFT JOIN ' |
|
| 720 | + . EEM_Transaction::instance()->table() |
|
| 721 | + . ' t ON r.TXN_ID = t.TXN_ID WHERE t.TXN_ID IS NULL'); |
|
| 722 | + } |
|
| 723 | + |
|
| 724 | + |
|
| 725 | + /** |
|
| 726 | + * Count registrations checked into (or out of) a datetime |
|
| 727 | + * |
|
| 728 | + * @param int $DTT_ID datetime ID |
|
| 729 | + * @param boolean $checked_in whether to count registrations checked IN or OUT |
|
| 730 | + * @return int |
|
| 731 | + * @throws EE_Error |
|
| 732 | + */ |
|
| 733 | + public function count_registrations_checked_into_datetime($DTT_ID, $checked_in = true) |
|
| 734 | + { |
|
| 735 | + global $wpdb; |
|
| 736 | + //subquery to get latest checkin |
|
| 737 | + $query = $wpdb->prepare( |
|
| 738 | + 'SELECT ' |
|
| 739 | + . 'COUNT( DISTINCT checkins.REG_ID ) ' |
|
| 740 | + . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN' |
|
| 741 | + . '( SELECT ' |
|
| 742 | + . 'max( CHK_timestamp ) AS latest_checkin, ' |
|
| 743 | + . 'REG_ID AS REG_ID ' |
|
| 744 | + . 'FROM ' . EEM_Checkin::instance()->table() . ' ' |
|
| 745 | + . 'WHERE DTT_ID=%d ' |
|
| 746 | + . 'GROUP BY REG_ID' |
|
| 747 | + . ') AS most_recent_checkin_per_reg ' |
|
| 748 | + . 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID ' |
|
| 749 | + . 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin ' |
|
| 750 | + . 'WHERE ' |
|
| 751 | + . 'checkins.CHK_in=%d', |
|
| 752 | + $DTT_ID, |
|
| 753 | + $checked_in |
|
| 754 | + ); |
|
| 755 | + return (int)$wpdb->get_var($query); |
|
| 756 | + } |
|
| 757 | + |
|
| 758 | + |
|
| 759 | + /** |
|
| 760 | + * Count registrations checked into (or out of) an event. |
|
| 761 | + * |
|
| 762 | + * @param int $EVT_ID event ID |
|
| 763 | + * @param boolean $checked_in whether to count registrations checked IN or OUT |
|
| 764 | + * @return int |
|
| 765 | + * @throws EE_Error |
|
| 766 | + */ |
|
| 767 | + public function count_registrations_checked_into_event($EVT_ID, $checked_in = true) |
|
| 768 | + { |
|
| 769 | + global $wpdb; |
|
| 770 | + //subquery to get latest checkin |
|
| 771 | + $query = $wpdb->prepare( |
|
| 772 | + 'SELECT ' |
|
| 773 | + . 'COUNT( DISTINCT checkins.REG_ID ) ' |
|
| 774 | + . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN' |
|
| 775 | + . '( SELECT ' |
|
| 776 | + . 'max( CHK_timestamp ) AS latest_checkin, ' |
|
| 777 | + . 'REG_ID AS REG_ID ' |
|
| 778 | + . 'FROM ' . EEM_Checkin::instance()->table() . ' AS c ' |
|
| 779 | + . 'INNER JOIN ' . EEM_Datetime::instance()->table() . ' AS d ' |
|
| 780 | + . 'ON c.DTT_ID=d.DTT_ID ' |
|
| 781 | + . 'WHERE d.EVT_ID=%d ' |
|
| 782 | + . 'GROUP BY REG_ID' |
|
| 783 | + . ') AS most_recent_checkin_per_reg ' |
|
| 784 | + . 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID ' |
|
| 785 | + . 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin ' |
|
| 786 | + . 'WHERE ' |
|
| 787 | + . 'checkins.CHK_in=%d', |
|
| 788 | + $EVT_ID, |
|
| 789 | + $checked_in |
|
| 790 | + ); |
|
| 791 | + return (int)$wpdb->get_var($query); |
|
| 792 | + } |
|
| 793 | + |
|
| 794 | + |
|
| 795 | + /** |
|
| 796 | + * The purpose of this method is to retrieve an array of |
|
| 797 | + * EE_Registration objects that represent the latest registration |
|
| 798 | + * for each ATT_ID given in the function argument. |
|
| 799 | + * |
|
| 800 | + * @param array $attendee_ids |
|
| 801 | + * @return EE_Base_Class[]|EE_Registration[] |
|
| 802 | + * @throws EE_Error |
|
| 803 | + */ |
|
| 804 | + public function get_latest_registration_for_each_of_given_contacts($attendee_ids = array()) |
|
| 805 | + { |
|
| 806 | + //first do a native wp_query to get the latest REG_ID's matching these attendees. |
|
| 807 | + global $wpdb; |
|
| 808 | + $registration_table = $wpdb->prefix . 'esp_registration'; |
|
| 809 | + $attendee_table = $wpdb->posts; |
|
| 810 | + $attendee_ids = is_array($attendee_ids) |
|
| 811 | + ? array_map('absint', $attendee_ids) |
|
| 812 | + : array((int)$attendee_ids); |
|
| 813 | + $ATT_IDs = implode(',', $attendee_ids); |
|
| 814 | + // first we do a query to get the registration ids |
|
| 815 | + // (because a group by before order by causes the order by to be ignored.) |
|
| 816 | + $registration_id_query = " |
|
| 817 | 817 | SELECT registrations.registration_ids as registration_id |
| 818 | 818 | FROM ( |
| 819 | 819 | SELECT |
@@ -827,63 +827,63 @@ discard block |
||
| 827 | 827 | ) AS registrations |
| 828 | 828 | GROUP BY registrations.attendee_ids |
| 829 | 829 | "; |
| 830 | - $registration_ids = $wpdb->get_results($registration_id_query, ARRAY_A); |
|
| 831 | - if (empty($registration_ids)) { |
|
| 832 | - return array(); |
|
| 833 | - } |
|
| 834 | - $ids_for_model_query = array(); |
|
| 835 | - //let's flatten the ids so they can be used in the model query. |
|
| 836 | - foreach ($registration_ids as $registration_id) { |
|
| 837 | - if (isset($registration_id['registration_id'])) { |
|
| 838 | - $ids_for_model_query[] = $registration_id['registration_id']; |
|
| 839 | - } |
|
| 840 | - } |
|
| 841 | - //construct query |
|
| 842 | - $_where = array( |
|
| 843 | - 'REG_ID' => array('IN', $ids_for_model_query), |
|
| 844 | - ); |
|
| 845 | - return $this->get_all(array($_where)); |
|
| 846 | - } |
|
| 847 | - |
|
| 848 | - |
|
| 849 | - |
|
| 850 | - /** |
|
| 851 | - * returns a count of registrations for the supplied event having the status as specified |
|
| 852 | - * |
|
| 853 | - * @param int $EVT_ID |
|
| 854 | - * @param array $statuses |
|
| 855 | - * @return int |
|
| 856 | - * @throws InvalidArgumentException |
|
| 857 | - * @throws InvalidStatusException |
|
| 858 | - * @throws EE_Error |
|
| 859 | - */ |
|
| 860 | - public function event_reg_count_for_statuses($EVT_ID, $statuses = array() ) |
|
| 861 | - { |
|
| 862 | - $EVT_ID = absint($EVT_ID); |
|
| 863 | - if (! $EVT_ID) { |
|
| 864 | - throw new InvalidArgumentException( |
|
| 865 | - esc_html__('An invalid Event ID was supplied.', 'event_espresso') |
|
| 866 | - ); |
|
| 867 | - } |
|
| 868 | - $statuses = is_array($statuses) ? $statuses : array($statuses); |
|
| 869 | - $statuses = ! empty($statuses) ? $statuses : array(EEM_Registration::status_id_approved); |
|
| 870 | - $valid_reg_statuses = EEM_Registration::reg_statuses(); |
|
| 871 | - foreach ($statuses as $status) { |
|
| 872 | - if(! in_array($status, $valid_reg_statuses, true)) { |
|
| 873 | - throw new InvalidStatusException($status, esc_html__('Registration', 'event_espresso')); |
|
| 874 | - } |
|
| 875 | - } |
|
| 876 | - return $this->count( |
|
| 877 | - array( |
|
| 878 | - array( |
|
| 879 | - 'EVT_ID' => $EVT_ID, |
|
| 880 | - 'STS_ID' => array('IN', $statuses), |
|
| 881 | - ), |
|
| 882 | - ), |
|
| 883 | - 'REG_ID', |
|
| 884 | - true |
|
| 885 | - ); |
|
| 886 | - } |
|
| 830 | + $registration_ids = $wpdb->get_results($registration_id_query, ARRAY_A); |
|
| 831 | + if (empty($registration_ids)) { |
|
| 832 | + return array(); |
|
| 833 | + } |
|
| 834 | + $ids_for_model_query = array(); |
|
| 835 | + //let's flatten the ids so they can be used in the model query. |
|
| 836 | + foreach ($registration_ids as $registration_id) { |
|
| 837 | + if (isset($registration_id['registration_id'])) { |
|
| 838 | + $ids_for_model_query[] = $registration_id['registration_id']; |
|
| 839 | + } |
|
| 840 | + } |
|
| 841 | + //construct query |
|
| 842 | + $_where = array( |
|
| 843 | + 'REG_ID' => array('IN', $ids_for_model_query), |
|
| 844 | + ); |
|
| 845 | + return $this->get_all(array($_where)); |
|
| 846 | + } |
|
| 847 | + |
|
| 848 | + |
|
| 849 | + |
|
| 850 | + /** |
|
| 851 | + * returns a count of registrations for the supplied event having the status as specified |
|
| 852 | + * |
|
| 853 | + * @param int $EVT_ID |
|
| 854 | + * @param array $statuses |
|
| 855 | + * @return int |
|
| 856 | + * @throws InvalidArgumentException |
|
| 857 | + * @throws InvalidStatusException |
|
| 858 | + * @throws EE_Error |
|
| 859 | + */ |
|
| 860 | + public function event_reg_count_for_statuses($EVT_ID, $statuses = array() ) |
|
| 861 | + { |
|
| 862 | + $EVT_ID = absint($EVT_ID); |
|
| 863 | + if (! $EVT_ID) { |
|
| 864 | + throw new InvalidArgumentException( |
|
| 865 | + esc_html__('An invalid Event ID was supplied.', 'event_espresso') |
|
| 866 | + ); |
|
| 867 | + } |
|
| 868 | + $statuses = is_array($statuses) ? $statuses : array($statuses); |
|
| 869 | + $statuses = ! empty($statuses) ? $statuses : array(EEM_Registration::status_id_approved); |
|
| 870 | + $valid_reg_statuses = EEM_Registration::reg_statuses(); |
|
| 871 | + foreach ($statuses as $status) { |
|
| 872 | + if(! in_array($status, $valid_reg_statuses, true)) { |
|
| 873 | + throw new InvalidStatusException($status, esc_html__('Registration', 'event_espresso')); |
|
| 874 | + } |
|
| 875 | + } |
|
| 876 | + return $this->count( |
|
| 877 | + array( |
|
| 878 | + array( |
|
| 879 | + 'EVT_ID' => $EVT_ID, |
|
| 880 | + 'STS_ID' => array('IN', $statuses), |
|
| 881 | + ), |
|
| 882 | + ), |
|
| 883 | + 'REG_ID', |
|
| 884 | + true |
|
| 885 | + ); |
|
| 886 | + } |
|
| 887 | 887 | |
| 888 | 888 | } |
| 889 | 889 | // End of file EEM_Registration.model.php |