eventespresso /
event-espresso-core
@@ -34,37 +34,37 @@ |
||
| 34 | 34 | */ |
| 35 | 35 | class Post implements RequestMethod |
| 36 | 36 | { |
| 37 | - /** |
|
| 38 | - * URL to which requests are POSTed. |
|
| 39 | - * @const string |
|
| 40 | - */ |
|
| 41 | - const SITE_VERIFY_URL = 'https://www.google.com/recaptcha/api/siteverify'; |
|
| 37 | + /** |
|
| 38 | + * URL to which requests are POSTed. |
|
| 39 | + * @const string |
|
| 40 | + */ |
|
| 41 | + const SITE_VERIFY_URL = 'https://www.google.com/recaptcha/api/siteverify'; |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * Submit the POST request with the specified parameters. |
|
| 45 | - * |
|
| 46 | - * @param RequestParameters $params Request parameters |
|
| 47 | - * @return string Body of the reCAPTCHA response |
|
| 48 | - */ |
|
| 49 | - public function submit(RequestParameters $params) |
|
| 50 | - { |
|
| 51 | - /** |
|
| 52 | - * PHP 5.6.0 changed the way you specify the peer name for SSL context options. |
|
| 53 | - * Using "CN_name" will still work, but it will raise deprecated errors. |
|
| 54 | - */ |
|
| 55 | - $peer_key = version_compare(PHP_VERSION, '5.6.0', '<') ? 'CN_name' : 'peer_name'; |
|
| 56 | - $options = array( |
|
| 57 | - 'http' => array( |
|
| 58 | - 'header' => "Content-type: application/x-www-form-urlencoded\r\n", |
|
| 59 | - 'method' => 'POST', |
|
| 60 | - 'content' => $params->toQueryString(), |
|
| 61 | - // Force the peer to validate (not needed in 5.6.0+, but still works |
|
| 62 | - 'verify_peer' => true, |
|
| 63 | - // Force the peer validation to use www.google.com |
|
| 64 | - $peer_key => 'www.google.com', |
|
| 65 | - ), |
|
| 66 | - ); |
|
| 67 | - $context = stream_context_create($options); |
|
| 68 | - return file_get_contents(self::SITE_VERIFY_URL, false, $context); |
|
| 69 | - } |
|
| 43 | + /** |
|
| 44 | + * Submit the POST request with the specified parameters. |
|
| 45 | + * |
|
| 46 | + * @param RequestParameters $params Request parameters |
|
| 47 | + * @return string Body of the reCAPTCHA response |
|
| 48 | + */ |
|
| 49 | + public function submit(RequestParameters $params) |
|
| 50 | + { |
|
| 51 | + /** |
|
| 52 | + * PHP 5.6.0 changed the way you specify the peer name for SSL context options. |
|
| 53 | + * Using "CN_name" will still work, but it will raise deprecated errors. |
|
| 54 | + */ |
|
| 55 | + $peer_key = version_compare(PHP_VERSION, '5.6.0', '<') ? 'CN_name' : 'peer_name'; |
|
| 56 | + $options = array( |
|
| 57 | + 'http' => array( |
|
| 58 | + 'header' => "Content-type: application/x-www-form-urlencoded\r\n", |
|
| 59 | + 'method' => 'POST', |
|
| 60 | + 'content' => $params->toQueryString(), |
|
| 61 | + // Force the peer to validate (not needed in 5.6.0+, but still works |
|
| 62 | + 'verify_peer' => true, |
|
| 63 | + // Force the peer validation to use www.google.com |
|
| 64 | + $peer_key => 'www.google.com', |
|
| 65 | + ), |
|
| 66 | + ); |
|
| 67 | + $context = stream_context_create($options); |
|
| 68 | + return file_get_contents(self::SITE_VERIFY_URL, false, $context); |
|
| 69 | + } |
|
| 70 | 70 | } |
@@ -32,11 +32,11 @@ |
||
| 32 | 32 | interface RequestMethod |
| 33 | 33 | { |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * Submit the request with the specified parameters. |
|
| 37 | - * |
|
| 38 | - * @param RequestParameters $params Request parameters |
|
| 39 | - * @return string Body of the reCAPTCHA response |
|
| 40 | - */ |
|
| 41 | - public function submit(RequestParameters $params); |
|
| 35 | + /** |
|
| 36 | + * Submit the request with the specified parameters. |
|
| 37 | + * |
|
| 38 | + * @param RequestParameters $params Request parameters |
|
| 39 | + * @return string Body of the reCAPTCHA response |
|
| 40 | + */ |
|
| 41 | + public function submit(RequestParameters $params); |
|
| 42 | 42 | } |
@@ -40,8 +40,11 @@ discard block |
||
| 40 | 40 | <?php echo do_shortcode( $venue_description ); ?> |
| 41 | 41 | </p> |
| 42 | 42 | <?php endif; ?> |
| 43 | - <?php else : ?> |
|
| 44 | - <?php $venue_excerpt = espresso_venue_excerpt( $VNU_ID, FALSE ); ?> |
|
| 43 | + <?php else { |
|
| 44 | + : ?> |
|
| 45 | + <?php $venue_excerpt = espresso_venue_excerpt( $VNU_ID, FALSE ); |
|
| 46 | +} |
|
| 47 | +?> |
|
| 45 | 48 | <?php if ( $venue_excerpt ) : ?> |
| 46 | 49 | <p> |
| 47 | 50 | <strong><?php _e( 'Description:', 'event_espresso' ); ?></strong><br/> |
@@ -53,12 +56,15 @@ discard block |
||
| 53 | 56 | <!-- .espresso-venue-dv --> |
| 54 | 57 | <?php |
| 55 | 58 | do_action( 'AHEE_event_details_after_venue_details', $post ); |
| 56 | -else : |
|
| 59 | +else { |
|
| 60 | + : |
|
| 57 | 61 | if ( espresso_venue_is_password_protected() ) : |
| 58 | 62 | ?> |
| 59 | 63 | <div class="espresso-venue-dv espresso-password-protected-venue-dv" > |
| 60 | 64 | <h3 class="event-venues-h3 ee-event-h3"> |
| 61 | - <?php _e( 'Location', 'event_espresso' );?> |
|
| 65 | + <?php _e( 'Location', 'event_espresso' ); |
|
| 66 | +} |
|
| 67 | +?> |
|
| 62 | 68 | </h3> |
| 63 | 69 | <?php echo espresso_password_protected_venue_form(); ?> |
| 64 | 70 | </div> |
@@ -1,66 +1,66 @@ |
||
| 1 | 1 | <?php |
| 2 | 2 | //echo '<br/><h6 style="color:#2EA2CC;">'. __FILE__ . ' <span style="font-weight:normal;color:#E76700"> Line #: ' . __LINE__ . '</span></h6>'; |
| 3 | 3 | if ( |
| 4 | - ( is_single() && espresso_display_venue_in_event_details() ) |
|
| 5 | - || ( is_archive() && espresso_display_venue_in_event_list() ) |
|
| 4 | + (is_single() && espresso_display_venue_in_event_details()) |
|
| 5 | + || (is_archive() && espresso_display_venue_in_event_list()) |
|
| 6 | 6 | ) : |
| 7 | 7 | global $post; |
| 8 | - do_action( 'AHEE_event_details_before_venue_details', $post ); |
|
| 9 | - $venue_name = espresso_venue_name( 0, 'details', FALSE ); |
|
| 10 | - if ( empty( $venue_name ) && espresso_is_venue_private() ) { |
|
| 11 | - do_action( 'AHEE_event_details_after_venue_details', $post ); |
|
| 8 | + do_action('AHEE_event_details_before_venue_details', $post); |
|
| 9 | + $venue_name = espresso_venue_name(0, 'details', FALSE); |
|
| 10 | + if (empty($venue_name) && espresso_is_venue_private()) { |
|
| 11 | + do_action('AHEE_event_details_after_venue_details', $post); |
|
| 12 | 12 | return ''; |
| 13 | 13 | } |
| 14 | 14 | ?> |
| 15 | 15 | |
| 16 | 16 | <div class="espresso-venue-dv<?php echo espresso_is_venue_private() ? ' espresso-private-venue-dv' : ''; ?>"> |
| 17 | - <h4><strong><?php _e( 'Venue:', 'event_espresso' ); ?></strong> <strong> <?php echo $venue_name; ?></strong></h4> |
|
| 17 | + <h4><strong><?php _e('Venue:', 'event_espresso'); ?></strong> <strong> <?php echo $venue_name; ?></strong></h4> |
|
| 18 | 18 | <p><span class="smaller-text tags-links"><?php echo espresso_venue_categories(); ?></span></p> |
| 19 | -<?php if ( $venue_phone = espresso_venue_phone( $post->ID, FALSE )) : ?> |
|
| 19 | +<?php if ($venue_phone = espresso_venue_phone($post->ID, FALSE)) : ?> |
|
| 20 | 20 | <p> |
| 21 | - <span class="small-text"><strong><?php _e( 'Venue Phone:', 'event_espresso' ); ?></strong></span> <?php echo $venue_phone; ?> |
|
| 21 | + <span class="small-text"><strong><?php _e('Venue Phone:', 'event_espresso'); ?></strong></span> <?php echo $venue_phone; ?> |
|
| 22 | 22 | </p> |
| 23 | -<?php endif; ?> |
|
| 24 | -<?php if ( $venue_website = espresso_venue_website( $post->ID, FALSE )) : ?> |
|
| 23 | +<?php endif; ?> |
|
| 24 | +<?php if ($venue_website = espresso_venue_website($post->ID, FALSE)) : ?> |
|
| 25 | 25 | <p> |
| 26 | - <span class="small-text"><strong><?php _e( 'Venue Website:', 'event_espresso' ); ?></strong></span> <?php echo $venue_website; ?> |
|
| 26 | + <span class="small-text"><strong><?php _e('Venue Website:', 'event_espresso'); ?></strong></span> <?php echo $venue_website; ?> |
|
| 27 | 27 | </p> |
| 28 | 28 | <?php endif; ?> |
| 29 | -<?php if ( espresso_venue_has_address( $post->ID )) : ?> |
|
| 30 | - <strong><span class="dashicons dashicons-location-alt"></span><?php _e( 'Address:', 'event_espresso' ); ?></strong> |
|
| 31 | - <?php espresso_venue_address( 'inline' ); ?> |
|
| 32 | - <?php espresso_venue_gmap( $post->ID ); ?> |
|
| 29 | +<?php if (espresso_venue_has_address($post->ID)) : ?> |
|
| 30 | + <strong><span class="dashicons dashicons-location-alt"></span><?php _e('Address:', 'event_espresso'); ?></strong> |
|
| 31 | + <?php espresso_venue_address('inline'); ?> |
|
| 32 | + <?php espresso_venue_gmap($post->ID); ?> |
|
| 33 | 33 | <div class="clear"><br/></div> |
| 34 | -<?php endif; ?> |
|
| 34 | +<?php endif; ?> |
|
| 35 | 35 | |
| 36 | - <?php $VNU_ID = espresso_venue_id( $post->ID ); ?> |
|
| 37 | - <?php if ( is_single() ) : ?> |
|
| 38 | - <?php $venue_description = espresso_venue_description( $VNU_ID, FALSE ); ?> |
|
| 39 | - <?php if ( $venue_description ) : ?> |
|
| 36 | + <?php $VNU_ID = espresso_venue_id($post->ID); ?> |
|
| 37 | + <?php if (is_single()) : ?> |
|
| 38 | + <?php $venue_description = espresso_venue_description($VNU_ID, FALSE); ?> |
|
| 39 | + <?php if ($venue_description) : ?> |
|
| 40 | 40 | <p> |
| 41 | - <strong><?php _e( 'Description:', 'event_espresso' ); ?></strong><br/> |
|
| 42 | - <?php echo do_shortcode( $venue_description ); ?> |
|
| 41 | + <strong><?php _e('Description:', 'event_espresso'); ?></strong><br/> |
|
| 42 | + <?php echo do_shortcode($venue_description); ?> |
|
| 43 | 43 | </p> |
| 44 | - <?php endif; ?> |
|
| 44 | + <?php endif; ?> |
|
| 45 | 45 | <?php else : ?> |
| 46 | - <?php $venue_excerpt = espresso_venue_excerpt( $VNU_ID, FALSE ); ?> |
|
| 47 | - <?php if ( $venue_excerpt ) : ?> |
|
| 46 | + <?php $venue_excerpt = espresso_venue_excerpt($VNU_ID, FALSE); ?> |
|
| 47 | + <?php if ($venue_excerpt) : ?> |
|
| 48 | 48 | <p> |
| 49 | - <strong><?php _e( 'Description:', 'event_espresso' ); ?></strong><br/> |
|
| 49 | + <strong><?php _e('Description:', 'event_espresso'); ?></strong><br/> |
|
| 50 | 50 | <?php echo $venue_excerpt; ?> |
| 51 | 51 | </p> |
| 52 | - <?php endif; ?> |
|
| 53 | - <?php endif; ?> |
|
| 52 | + <?php endif; ?> |
|
| 53 | + <?php endif; ?> |
|
| 54 | 54 | </div> |
| 55 | 55 | <!-- .espresso-venue-dv --> |
| 56 | 56 | <?php |
| 57 | -do_action( 'AHEE_event_details_after_venue_details', $post ); |
|
| 57 | +do_action('AHEE_event_details_after_venue_details', $post); |
|
| 58 | 58 | else : |
| 59 | - if ( espresso_venue_is_password_protected() ) : |
|
| 59 | + if (espresso_venue_is_password_protected()) : |
|
| 60 | 60 | ?> |
| 61 | 61 | <div class="espresso-venue-dv espresso-password-protected-venue-dv" > |
| 62 | 62 | <h3 class="event-venues-h3 ee-event-h3"> |
| 63 | - <?php _e( 'Location', 'event_espresso' );?> |
|
| 63 | + <?php _e('Location', 'event_espresso'); ?> |
|
| 64 | 64 | </h3> |
| 65 | 65 | <?php echo espresso_password_protected_venue_form(); ?> |
| 66 | 66 | </div> |
@@ -8,9 +8,9 @@ discard block |
||
| 8 | 8 | * @param $class_file |
| 9 | 9 | * @return array |
| 10 | 10 | */ |
| 11 | -function espresso_invoice_template_files( $class_file) { |
|
| 11 | +function espresso_invoice_template_files($class_file) { |
|
| 12 | 12 | // read our template dir and build an array of files |
| 13 | - $dhandle = opendir(dirname($class_file) . '/lib/templates/css/'); //If the template files have been moved to the uploads folder |
|
| 13 | + $dhandle = opendir(dirname($class_file).'/lib/templates/css/'); //If the template files have been moved to the uploads folder |
|
| 14 | 14 | //} else return FALSE; |
| 15 | 15 | |
| 16 | 16 | $files = array(); |
@@ -50,8 +50,8 @@ discard block |
||
| 50 | 50 | * @param string $selected |
| 51 | 51 | * @return string |
| 52 | 52 | */ |
| 53 | -function espresso_invoice_is_selected( $input_item, $selected='') { |
|
| 54 | - if ( $input_item === $selected ) { |
|
| 53 | +function espresso_invoice_is_selected($input_item, $selected = '') { |
|
| 54 | + if ($input_item === $selected) { |
|
| 55 | 55 | return 'selected="selected"'; |
| 56 | 56 | } else { |
| 57 | 57 | return ''; |
@@ -418,7 +418,7 @@ |
||
| 418 | 418 | * In this case, we delete the temporary file |
| 419 | 419 | * |
| 420 | 420 | * @param JobParameters $job_parameters |
| 421 | - * @return boolean |
|
| 421 | + * @return JobStepResponse |
|
| 422 | 422 | */ |
| 423 | 423 | public function cleanup_job(JobParameters $job_parameters) |
| 424 | 424 | { |
@@ -45,7 +45,7 @@ discard block |
||
| 45 | 45 | public function create_job(JobParameters $job_parameters) |
| 46 | 46 | { |
| 47 | 47 | $event_id = intval($job_parameters->request_datum('EVT_ID', '0')); |
| 48 | - if (! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) { |
|
| 48 | + if ( ! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) { |
|
| 49 | 49 | throw new BatchRequestException(__('You do not have permission to view registrations', 'event_espresso')); |
| 50 | 50 | } |
| 51 | 51 | $filepath = $this->create_file_from_job_with_name( |
@@ -82,7 +82,7 @@ discard block |
||
| 82 | 82 | $query_params['force_join'][] = 'Event'; |
| 83 | 83 | } |
| 84 | 84 | } |
| 85 | - if (! isset($query_params['force_join'])) { |
|
| 85 | + if ( ! isset($query_params['force_join'])) { |
|
| 86 | 86 | $query_params['force_join'] = array('Event', 'Transaction', 'Ticket', 'Attendee'); |
| 87 | 87 | } |
| 88 | 88 | $job_parameters->add_extra_data('query_params', $query_params); |
@@ -172,10 +172,10 @@ discard block |
||
| 172 | 172 | $question_where_params = array(); |
| 173 | 173 | foreach ($reg_where_params as $key => $val) { |
| 174 | 174 | if (\EEM_Registration::instance()->is_logic_query_param_key($key)) { |
| 175 | - $question_where_params[ $key ] = $this->_change_registration_where_params_to_question_where_params($val); |
|
| 175 | + $question_where_params[$key] = $this->_change_registration_where_params_to_question_where_params($val); |
|
| 176 | 176 | } else { |
| 177 | 177 | // it's a normal where condition |
| 178 | - $question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val; |
|
| 178 | + $question_where_params['Question_Group.Event.Registration.'.$key] = $val; |
|
| 179 | 179 | } |
| 180 | 180 | } |
| 181 | 181 | return $question_where_params; |
@@ -268,9 +268,9 @@ discard block |
||
| 268 | 268 | foreach ($registration_rows as $reg_row) { |
| 269 | 269 | if (is_array($reg_row)) { |
| 270 | 270 | $reg_csv_array = array(); |
| 271 | - if (! $event_id) { |
|
| 271 | + if ( ! $event_id) { |
|
| 272 | 272 | // get the event's name and Id |
| 273 | - $reg_csv_array[ (string) __('Event', 'event_espresso') ] = sprintf( |
|
| 273 | + $reg_csv_array[(string) __('Event', 'event_espresso')] = sprintf( |
|
| 274 | 274 | /* translators: 1: event name, 2: event ID */ |
| 275 | 275 | __('%1$s (%2$s)', 'event_espresso'), |
| 276 | 276 | EEH_Export::prepare_value_from_db_for_display( |
@@ -318,13 +318,13 @@ discard block |
||
| 318 | 318 | $value = EEH_Export::prepare_value_from_db_for_display( |
| 319 | 319 | $reg_model, |
| 320 | 320 | $field_name, |
| 321 | - $reg_row[ $field->get_qualified_column() ] |
|
| 321 | + $reg_row[$field->get_qualified_column()] |
|
| 322 | 322 | ); |
| 323 | 323 | } |
| 324 | - $reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = $value; |
|
| 324 | + $reg_csv_array[EEH_Export::get_column_name_for_field($field)] = $value; |
|
| 325 | 325 | if ($field_name == 'REG_final_price') { |
| 326 | 326 | // add a column named Currency after the final price |
| 327 | - $reg_csv_array[ (string) __("Currency", "event_espresso") ] = \EE_Config::instance()->currency->code; |
|
| 327 | + $reg_csv_array[(string) __("Currency", "event_espresso")] = \EE_Config::instance()->currency->code; |
|
| 328 | 328 | } |
| 329 | 329 | } |
| 330 | 330 | // get pretty status |
@@ -336,17 +336,17 @@ discard block |
||
| 336 | 336 | false, |
| 337 | 337 | 'sentence' |
| 338 | 338 | ); |
| 339 | - $reg_csv_array[ (string) __("Registration Status", 'event_espresso') ] = $stati[ $reg_row['Registration.STS_ID'] ]; |
|
| 339 | + $reg_csv_array[(string) __("Registration Status", 'event_espresso')] = $stati[$reg_row['Registration.STS_ID']]; |
|
| 340 | 340 | // get pretty transaction status |
| 341 | - $reg_csv_array[ (string) __("Transaction Status", 'event_espresso') ] = $stati[ $reg_row['TransactionTable.STS_ID'] ]; |
|
| 342 | - $reg_csv_array[ (string) __('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg |
|
| 341 | + $reg_csv_array[(string) __("Transaction Status", 'event_espresso')] = $stati[$reg_row['TransactionTable.STS_ID']]; |
|
| 342 | + $reg_csv_array[(string) __('Transaction Amount Due', 'event_espresso')] = $is_primary_reg |
|
| 343 | 343 | ? EEH_Export::prepare_value_from_db_for_display( |
| 344 | 344 | EEM_Transaction::instance(), |
| 345 | 345 | 'TXN_total', |
| 346 | 346 | $reg_row['TransactionTable.TXN_total'], |
| 347 | 347 | 'localized_float' |
| 348 | 348 | ) : '0.00'; |
| 349 | - $reg_csv_array[ (string) __('Amount Paid', 'event_espresso') ] = $is_primary_reg |
|
| 349 | + $reg_csv_array[(string) __('Amount Paid', 'event_espresso')] = $is_primary_reg |
|
| 350 | 350 | ? EEH_Export::prepare_value_from_db_for_display( |
| 351 | 351 | EEM_Transaction::instance(), |
| 352 | 352 | 'TXN_paid', |
@@ -377,14 +377,14 @@ discard block |
||
| 377 | 377 | ? $payment_method_and_gateway_txn_id['payment_time'] : ''; |
| 378 | 378 | } |
| 379 | 379 | } |
| 380 | - $reg_csv_array[ (string) __('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times); |
|
| 381 | - $reg_csv_array[ (string) __('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods); |
|
| 382 | - $reg_csv_array[ (string) __('Gateway Transaction ID(s)', 'event_espresso') ] = implode( |
|
| 380 | + $reg_csv_array[(string) __('Payment Date(s)', 'event_espresso')] = implode(',', $payment_times); |
|
| 381 | + $reg_csv_array[(string) __('Payment Method(s)', 'event_espresso')] = implode(",", $payment_methods); |
|
| 382 | + $reg_csv_array[(string) __('Gateway Transaction ID(s)', 'event_espresso')] = implode( |
|
| 383 | 383 | ',', |
| 384 | 384 | $gateway_txn_ids_etc |
| 385 | 385 | ); |
| 386 | 386 | // get whether or not the user has checked in |
| 387 | - $reg_csv_array[ (string) __("Check-Ins", "event_espresso") ] = $reg_model->count_related( |
|
| 387 | + $reg_csv_array[(string) __("Check-Ins", "event_espresso")] = $reg_model->count_related( |
|
| 388 | 388 | $reg_row['Registration.REG_ID'], |
| 389 | 389 | 'Checkin' |
| 390 | 390 | ); |
@@ -414,8 +414,8 @@ discard block |
||
| 414 | 414 | $ticket_name = __('Unknown', 'event_espresso'); |
| 415 | 415 | $datetimes_strings = array(__('Unknown', 'event_espresso')); |
| 416 | 416 | } |
| 417 | - $reg_csv_array[ (string) $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name; |
|
| 418 | - $reg_csv_array[ (string) __("Datetimes of Ticket", "event_espresso") ] = implode(", ", $datetimes_strings); |
|
| 417 | + $reg_csv_array[(string) $ticket_model->field_settings_for('TKT_name')->get_nicename()] = $ticket_name; |
|
| 418 | + $reg_csv_array[(string) __("Datetimes of Ticket", "event_espresso")] = implode(", ", $datetimes_strings); |
|
| 419 | 419 | // get datetime(s) of registration |
| 420 | 420 | // add attendee columns |
| 421 | 421 | foreach ($att_fields_to_include as $att_field_name) { |
@@ -435,18 +435,18 @@ discard block |
||
| 435 | 435 | $value = EEH_Export::prepare_value_from_db_for_display( |
| 436 | 436 | EEM_Attendee::instance(), |
| 437 | 437 | $att_field_name, |
| 438 | - $reg_row[ $field_obj->get_qualified_column() ] |
|
| 438 | + $reg_row[$field_obj->get_qualified_column()] |
|
| 439 | 439 | ); |
| 440 | 440 | } |
| 441 | 441 | } else { |
| 442 | 442 | $value = ''; |
| 443 | 443 | } |
| 444 | - $reg_csv_array[ EEH_Export::get_column_name_for_field($field_obj) ] = $value; |
|
| 444 | + $reg_csv_array[EEH_Export::get_column_name_for_field($field_obj)] = $value; |
|
| 445 | 445 | } |
| 446 | 446 | // make sure each registration has the same questions in the same order |
| 447 | 447 | foreach ($question_labels as $question_label) { |
| 448 | - if (! isset($reg_csv_array[ $question_label ])) { |
|
| 449 | - $reg_csv_array[ $question_label ] = null; |
|
| 448 | + if ( ! isset($reg_csv_array[$question_label])) { |
|
| 449 | + $reg_csv_array[$question_label] = null; |
|
| 450 | 450 | } |
| 451 | 451 | } |
| 452 | 452 | $answers = EEM_Answer::instance()->get_all_wpdb_results(array( |
@@ -467,12 +467,12 @@ discard block |
||
| 467 | 467 | if (isset($answer_row['Question.QST_type']) |
| 468 | 468 | && $answer_row['Question.QST_type'] == EEM_Question::QST_type_state |
| 469 | 469 | ) { |
| 470 | - $reg_csv_array[ $question_label ] = EEM_State::instance()->get_state_name_by_ID( |
|
| 470 | + $reg_csv_array[$question_label] = EEM_State::instance()->get_state_name_by_ID( |
|
| 471 | 471 | $answer_row['Answer.ANS_value'] |
| 472 | 472 | ); |
| 473 | 473 | } else { |
| 474 | 474 | // this isn't for html, so don't show html entities |
| 475 | - $reg_csv_array[ $question_label ] = html_entity_decode( |
|
| 475 | + $reg_csv_array[$question_label] = html_entity_decode( |
|
| 476 | 476 | EEH_Export::prepare_value_from_db_for_display( |
| 477 | 477 | EEM_Answer::instance(), |
| 478 | 478 | 'ANS_value', |
@@ -507,7 +507,7 @@ discard block |
||
| 507 | 507 | $model = EE_Registry::instance()->load_model($model_name); |
| 508 | 508 | foreach ($field_list as $field_name) { |
| 509 | 509 | $field = $model->field_settings_for($field_name); |
| 510 | - $reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = null; |
|
| 510 | + $reg_csv_array[EEH_Export::get_column_name_for_field($field)] = null; |
|
| 511 | 511 | } |
| 512 | 512 | } |
| 513 | 513 | $registrations_csv_ready_array[] = $reg_csv_array; |
@@ -31,530 +31,530 @@ |
||
| 31 | 31 | */ |
| 32 | 32 | class RegistrationsReport extends JobHandlerFile |
| 33 | 33 | { |
| 34 | - // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 35 | - // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore |
|
| 36 | - /** |
|
| 37 | - * Performs any necessary setup for starting the job. This is also a good |
|
| 38 | - * place to setup the $job_arguments which will be used for subsequent HTTP requests |
|
| 39 | - * when continue_job will be called |
|
| 40 | - * |
|
| 41 | - * @param JobParameters $job_parameters |
|
| 42 | - * @throws BatchRequestException |
|
| 43 | - * @return JobStepResponse |
|
| 44 | - */ |
|
| 45 | - public function create_job(JobParameters $job_parameters) |
|
| 46 | - { |
|
| 47 | - $event_id = intval($job_parameters->request_datum('EVT_ID', '0')); |
|
| 48 | - if (! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) { |
|
| 49 | - throw new BatchRequestException(__('You do not have permission to view registrations', 'event_espresso')); |
|
| 50 | - } |
|
| 51 | - $filepath = $this->create_file_from_job_with_name( |
|
| 52 | - $job_parameters->job_id(), |
|
| 53 | - $this->get_filename($event_id) |
|
| 54 | - ); |
|
| 55 | - $job_parameters->add_extra_data('filepath', $filepath); |
|
| 56 | - if ($job_parameters->request_datum('use_filters', false)) { |
|
| 57 | - $query_params = maybe_unserialize(stripslashes($job_parameters->request_datum('filters', array()))); |
|
| 58 | - } else { |
|
| 59 | - $query_params = apply_filters('FHEE__EE_Export__report_registration_for_event', array( |
|
| 60 | - array( |
|
| 61 | - 'OR' => array( |
|
| 62 | - // don't include registrations from failed or abandoned transactions... |
|
| 63 | - 'Transaction.STS_ID' => array( |
|
| 64 | - 'NOT IN', |
|
| 65 | - array( |
|
| 66 | - EEM_Transaction::failed_status_code, |
|
| 67 | - EEM_Transaction::abandoned_status_code, |
|
| 68 | - ), |
|
| 69 | - ), |
|
| 70 | - // unless the registration is approved, in which case include it regardless of transaction status |
|
| 71 | - 'STS_ID' => \EEM_Registration::status_id_approved, |
|
| 72 | - ), |
|
| 73 | - 'Ticket.TKT_deleted' => array('IN', array(true, false)), |
|
| 74 | - ), |
|
| 75 | - 'order_by' => array('Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'), |
|
| 76 | - 'force_join' => array('Transaction', 'Ticket', 'Attendee'), |
|
| 77 | - 'caps' => \EEM_Base::caps_read_admin, |
|
| 78 | - ), $event_id); |
|
| 79 | - if ($event_id) { |
|
| 80 | - $query_params[0]['EVT_ID'] = $event_id; |
|
| 81 | - } else { |
|
| 82 | - $query_params['force_join'][] = 'Event'; |
|
| 83 | - } |
|
| 84 | - } |
|
| 85 | - if (! isset($query_params['force_join'])) { |
|
| 86 | - $query_params['force_join'] = array('Event', 'Transaction', 'Ticket', 'Attendee'); |
|
| 87 | - } |
|
| 88 | - $job_parameters->add_extra_data('query_params', $query_params); |
|
| 89 | - $question_labels = $this->_get_question_labels($query_params); |
|
| 90 | - $job_parameters->add_extra_data('question_labels', $question_labels); |
|
| 91 | - $job_parameters->set_job_size( |
|
| 92 | - \EEM_Registration::instance()->count( |
|
| 93 | - array_diff_key( |
|
| 94 | - $query_params, |
|
| 95 | - array_flip( |
|
| 96 | - array('limit') |
|
| 97 | - ) |
|
| 98 | - ) |
|
| 99 | - ) |
|
| 100 | - ); |
|
| 101 | - // we should also set the header columns |
|
| 102 | - $csv_data_for_row = $this->get_csv_data_for( |
|
| 103 | - $event_id, |
|
| 104 | - 0, |
|
| 105 | - 1, |
|
| 106 | - $job_parameters->extra_datum('question_labels'), |
|
| 107 | - $job_parameters->extra_datum('query_params') |
|
| 108 | - ); |
|
| 109 | - EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true); |
|
| 110 | - // if we actually processed a row there, record it |
|
| 111 | - if ($job_parameters->job_size()) { |
|
| 112 | - $job_parameters->mark_processed(1); |
|
| 113 | - } |
|
| 114 | - return new JobStepResponse( |
|
| 115 | - $job_parameters, |
|
| 116 | - __('Registrations report started successfully...', 'event_espresso') |
|
| 117 | - ); |
|
| 118 | - } |
|
| 34 | + // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps |
|
| 35 | + // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore |
|
| 36 | + /** |
|
| 37 | + * Performs any necessary setup for starting the job. This is also a good |
|
| 38 | + * place to setup the $job_arguments which will be used for subsequent HTTP requests |
|
| 39 | + * when continue_job will be called |
|
| 40 | + * |
|
| 41 | + * @param JobParameters $job_parameters |
|
| 42 | + * @throws BatchRequestException |
|
| 43 | + * @return JobStepResponse |
|
| 44 | + */ |
|
| 45 | + public function create_job(JobParameters $job_parameters) |
|
| 46 | + { |
|
| 47 | + $event_id = intval($job_parameters->request_datum('EVT_ID', '0')); |
|
| 48 | + if (! \EE_Capabilities::instance()->current_user_can('ee_read_registrations', 'generating_report')) { |
|
| 49 | + throw new BatchRequestException(__('You do not have permission to view registrations', 'event_espresso')); |
|
| 50 | + } |
|
| 51 | + $filepath = $this->create_file_from_job_with_name( |
|
| 52 | + $job_parameters->job_id(), |
|
| 53 | + $this->get_filename($event_id) |
|
| 54 | + ); |
|
| 55 | + $job_parameters->add_extra_data('filepath', $filepath); |
|
| 56 | + if ($job_parameters->request_datum('use_filters', false)) { |
|
| 57 | + $query_params = maybe_unserialize(stripslashes($job_parameters->request_datum('filters', array()))); |
|
| 58 | + } else { |
|
| 59 | + $query_params = apply_filters('FHEE__EE_Export__report_registration_for_event', array( |
|
| 60 | + array( |
|
| 61 | + 'OR' => array( |
|
| 62 | + // don't include registrations from failed or abandoned transactions... |
|
| 63 | + 'Transaction.STS_ID' => array( |
|
| 64 | + 'NOT IN', |
|
| 65 | + array( |
|
| 66 | + EEM_Transaction::failed_status_code, |
|
| 67 | + EEM_Transaction::abandoned_status_code, |
|
| 68 | + ), |
|
| 69 | + ), |
|
| 70 | + // unless the registration is approved, in which case include it regardless of transaction status |
|
| 71 | + 'STS_ID' => \EEM_Registration::status_id_approved, |
|
| 72 | + ), |
|
| 73 | + 'Ticket.TKT_deleted' => array('IN', array(true, false)), |
|
| 74 | + ), |
|
| 75 | + 'order_by' => array('Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'), |
|
| 76 | + 'force_join' => array('Transaction', 'Ticket', 'Attendee'), |
|
| 77 | + 'caps' => \EEM_Base::caps_read_admin, |
|
| 78 | + ), $event_id); |
|
| 79 | + if ($event_id) { |
|
| 80 | + $query_params[0]['EVT_ID'] = $event_id; |
|
| 81 | + } else { |
|
| 82 | + $query_params['force_join'][] = 'Event'; |
|
| 83 | + } |
|
| 84 | + } |
|
| 85 | + if (! isset($query_params['force_join'])) { |
|
| 86 | + $query_params['force_join'] = array('Event', 'Transaction', 'Ticket', 'Attendee'); |
|
| 87 | + } |
|
| 88 | + $job_parameters->add_extra_data('query_params', $query_params); |
|
| 89 | + $question_labels = $this->_get_question_labels($query_params); |
|
| 90 | + $job_parameters->add_extra_data('question_labels', $question_labels); |
|
| 91 | + $job_parameters->set_job_size( |
|
| 92 | + \EEM_Registration::instance()->count( |
|
| 93 | + array_diff_key( |
|
| 94 | + $query_params, |
|
| 95 | + array_flip( |
|
| 96 | + array('limit') |
|
| 97 | + ) |
|
| 98 | + ) |
|
| 99 | + ) |
|
| 100 | + ); |
|
| 101 | + // we should also set the header columns |
|
| 102 | + $csv_data_for_row = $this->get_csv_data_for( |
|
| 103 | + $event_id, |
|
| 104 | + 0, |
|
| 105 | + 1, |
|
| 106 | + $job_parameters->extra_datum('question_labels'), |
|
| 107 | + $job_parameters->extra_datum('query_params') |
|
| 108 | + ); |
|
| 109 | + EEH_Export::write_data_array_to_csv($filepath, $csv_data_for_row, true); |
|
| 110 | + // if we actually processed a row there, record it |
|
| 111 | + if ($job_parameters->job_size()) { |
|
| 112 | + $job_parameters->mark_processed(1); |
|
| 113 | + } |
|
| 114 | + return new JobStepResponse( |
|
| 115 | + $job_parameters, |
|
| 116 | + __('Registrations report started successfully...', 'event_espresso') |
|
| 117 | + ); |
|
| 118 | + } |
|
| 119 | 119 | |
| 120 | 120 | |
| 121 | - /** |
|
| 122 | - * Gets the filename |
|
| 123 | - * |
|
| 124 | - * @return string |
|
| 125 | - */ |
|
| 126 | - protected function get_filename() |
|
| 127 | - { |
|
| 128 | - return sprintf("event-espresso-registrations-%s.csv", str_replace(':', '-', current_time('mysql'))); |
|
| 129 | - } |
|
| 121 | + /** |
|
| 122 | + * Gets the filename |
|
| 123 | + * |
|
| 124 | + * @return string |
|
| 125 | + */ |
|
| 126 | + protected function get_filename() |
|
| 127 | + { |
|
| 128 | + return sprintf("event-espresso-registrations-%s.csv", str_replace(':', '-', current_time('mysql'))); |
|
| 129 | + } |
|
| 130 | 130 | |
| 131 | 131 | |
| 132 | - /** |
|
| 133 | - * Gets the questions which are to be used for this report, so they |
|
| 134 | - * can be remembered for later |
|
| 135 | - * |
|
| 136 | - * @param array $registration_query_params |
|
| 137 | - * @return array question admin labels to be used for this report |
|
| 138 | - */ |
|
| 139 | - protected function _get_question_labels($registration_query_params) |
|
| 140 | - { |
|
| 141 | - $where = isset($registration_query_params[0]) ? $registration_query_params[0] : null; |
|
| 142 | - $question_query_params = array(); |
|
| 143 | - if ($where !== null) { |
|
| 144 | - $question_query_params = array( |
|
| 145 | - $this->_change_registration_where_params_to_question_where_params($registration_query_params[0]), |
|
| 146 | - ); |
|
| 147 | - } |
|
| 148 | - // Make sure it's not a system question |
|
| 149 | - $question_query_params[0]['OR*not-system-questions'] = [ |
|
| 150 | - 'QST_system' => '', |
|
| 151 | - 'QST_system*null' => ['IS_NULL'] |
|
| 152 | - ]; |
|
| 153 | - if (apply_filters( |
|
| 154 | - 'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport___get_question_labels__only_include_answered_questions', |
|
| 155 | - false, |
|
| 156 | - $registration_query_params |
|
| 157 | - )) { |
|
| 158 | - $question_query_params[0]['Answer.ANS_ID'] = array('IS_NOT_NULL'); |
|
| 159 | - } |
|
| 160 | - $question_query_params['group_by'] = array('QST_ID'); |
|
| 161 | - return array_unique(EEM_Question::instance()->get_col($question_query_params, 'QST_admin_label')); |
|
| 162 | - } |
|
| 132 | + /** |
|
| 133 | + * Gets the questions which are to be used for this report, so they |
|
| 134 | + * can be remembered for later |
|
| 135 | + * |
|
| 136 | + * @param array $registration_query_params |
|
| 137 | + * @return array question admin labels to be used for this report |
|
| 138 | + */ |
|
| 139 | + protected function _get_question_labels($registration_query_params) |
|
| 140 | + { |
|
| 141 | + $where = isset($registration_query_params[0]) ? $registration_query_params[0] : null; |
|
| 142 | + $question_query_params = array(); |
|
| 143 | + if ($where !== null) { |
|
| 144 | + $question_query_params = array( |
|
| 145 | + $this->_change_registration_where_params_to_question_where_params($registration_query_params[0]), |
|
| 146 | + ); |
|
| 147 | + } |
|
| 148 | + // Make sure it's not a system question |
|
| 149 | + $question_query_params[0]['OR*not-system-questions'] = [ |
|
| 150 | + 'QST_system' => '', |
|
| 151 | + 'QST_system*null' => ['IS_NULL'] |
|
| 152 | + ]; |
|
| 153 | + if (apply_filters( |
|
| 154 | + 'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport___get_question_labels__only_include_answered_questions', |
|
| 155 | + false, |
|
| 156 | + $registration_query_params |
|
| 157 | + )) { |
|
| 158 | + $question_query_params[0]['Answer.ANS_ID'] = array('IS_NOT_NULL'); |
|
| 159 | + } |
|
| 160 | + $question_query_params['group_by'] = array('QST_ID'); |
|
| 161 | + return array_unique(EEM_Question::instance()->get_col($question_query_params, 'QST_admin_label')); |
|
| 162 | + } |
|
| 163 | 163 | |
| 164 | 164 | |
| 165 | - /** |
|
| 166 | - * Takes where params meant for registrations and changes them to work for questions |
|
| 167 | - * |
|
| 168 | - * @param array $reg_where_params |
|
| 169 | - * @return array |
|
| 170 | - */ |
|
| 171 | - protected function _change_registration_where_params_to_question_where_params($reg_where_params) |
|
| 172 | - { |
|
| 173 | - $question_where_params = array(); |
|
| 174 | - foreach ($reg_where_params as $key => $val) { |
|
| 175 | - if (\EEM_Registration::instance()->is_logic_query_param_key($key)) { |
|
| 176 | - $question_where_params[ $key ] = $this->_change_registration_where_params_to_question_where_params($val); |
|
| 177 | - } else { |
|
| 178 | - // it's a normal where condition |
|
| 179 | - $question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val; |
|
| 180 | - } |
|
| 181 | - } |
|
| 182 | - return $question_where_params; |
|
| 183 | - } |
|
| 165 | + /** |
|
| 166 | + * Takes where params meant for registrations and changes them to work for questions |
|
| 167 | + * |
|
| 168 | + * @param array $reg_where_params |
|
| 169 | + * @return array |
|
| 170 | + */ |
|
| 171 | + protected function _change_registration_where_params_to_question_where_params($reg_where_params) |
|
| 172 | + { |
|
| 173 | + $question_where_params = array(); |
|
| 174 | + foreach ($reg_where_params as $key => $val) { |
|
| 175 | + if (\EEM_Registration::instance()->is_logic_query_param_key($key)) { |
|
| 176 | + $question_where_params[ $key ] = $this->_change_registration_where_params_to_question_where_params($val); |
|
| 177 | + } else { |
|
| 178 | + // it's a normal where condition |
|
| 179 | + $question_where_params[ 'Question_Group.Event.Registration.' . $key ] = $val; |
|
| 180 | + } |
|
| 181 | + } |
|
| 182 | + return $question_where_params; |
|
| 183 | + } |
|
| 184 | 184 | |
| 185 | 185 | |
| 186 | - /** |
|
| 187 | - * Performs another step of the job |
|
| 188 | - * |
|
| 189 | - * @param JobParameters $job_parameters |
|
| 190 | - * @param int $batch_size |
|
| 191 | - * @return JobStepResponse |
|
| 192 | - * @throws \EE_Error |
|
| 193 | - */ |
|
| 194 | - public function continue_job(JobParameters $job_parameters, $batch_size = 50) |
|
| 195 | - { |
|
| 196 | - if ($job_parameters->units_processed() < $job_parameters->job_size()) { |
|
| 197 | - $csv_data = $this->get_csv_data_for( |
|
| 198 | - $job_parameters->request_datum('EVT_ID', '0'), |
|
| 199 | - $job_parameters->units_processed(), |
|
| 200 | - $batch_size, |
|
| 201 | - $job_parameters->extra_datum('question_labels'), |
|
| 202 | - $job_parameters->extra_datum('query_params') |
|
| 203 | - ); |
|
| 204 | - EEH_Export::write_data_array_to_csv($job_parameters->extra_datum('filepath'), $csv_data, false); |
|
| 205 | - $units_processed = count($csv_data); |
|
| 206 | - } else { |
|
| 207 | - $csv_data = array(); |
|
| 208 | - $units_processed = 0; |
|
| 209 | - } |
|
| 210 | - $job_parameters->mark_processed($units_processed); |
|
| 211 | - $extra_response_data = array( |
|
| 212 | - 'file_url' => '', |
|
| 213 | - ); |
|
| 214 | - if ($units_processed < $batch_size) { |
|
| 215 | - $job_parameters->set_status(JobParameters::status_complete); |
|
| 216 | - $extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath')); |
|
| 217 | - } |
|
| 186 | + /** |
|
| 187 | + * Performs another step of the job |
|
| 188 | + * |
|
| 189 | + * @param JobParameters $job_parameters |
|
| 190 | + * @param int $batch_size |
|
| 191 | + * @return JobStepResponse |
|
| 192 | + * @throws \EE_Error |
|
| 193 | + */ |
|
| 194 | + public function continue_job(JobParameters $job_parameters, $batch_size = 50) |
|
| 195 | + { |
|
| 196 | + if ($job_parameters->units_processed() < $job_parameters->job_size()) { |
|
| 197 | + $csv_data = $this->get_csv_data_for( |
|
| 198 | + $job_parameters->request_datum('EVT_ID', '0'), |
|
| 199 | + $job_parameters->units_processed(), |
|
| 200 | + $batch_size, |
|
| 201 | + $job_parameters->extra_datum('question_labels'), |
|
| 202 | + $job_parameters->extra_datum('query_params') |
|
| 203 | + ); |
|
| 204 | + EEH_Export::write_data_array_to_csv($job_parameters->extra_datum('filepath'), $csv_data, false); |
|
| 205 | + $units_processed = count($csv_data); |
|
| 206 | + } else { |
|
| 207 | + $csv_data = array(); |
|
| 208 | + $units_processed = 0; |
|
| 209 | + } |
|
| 210 | + $job_parameters->mark_processed($units_processed); |
|
| 211 | + $extra_response_data = array( |
|
| 212 | + 'file_url' => '', |
|
| 213 | + ); |
|
| 214 | + if ($units_processed < $batch_size) { |
|
| 215 | + $job_parameters->set_status(JobParameters::status_complete); |
|
| 216 | + $extra_response_data['file_url'] = $this->get_url_to_file($job_parameters->extra_datum('filepath')); |
|
| 217 | + } |
|
| 218 | 218 | |
| 219 | - return new JobStepResponse( |
|
| 220 | - $job_parameters, |
|
| 221 | - sprintf(__('Wrote %1$s rows to report CSV file...', 'event_espresso'), count((array) $csv_data)), |
|
| 222 | - $extra_response_data |
|
| 223 | - ); |
|
| 224 | - } |
|
| 219 | + return new JobStepResponse( |
|
| 220 | + $job_parameters, |
|
| 221 | + sprintf(__('Wrote %1$s rows to report CSV file...', 'event_espresso'), count((array) $csv_data)), |
|
| 222 | + $extra_response_data |
|
| 223 | + ); |
|
| 224 | + } |
|
| 225 | 225 | |
| 226 | 226 | |
| 227 | - /** |
|
| 228 | - * Gets the csv data for a batch of registrations |
|
| 229 | - * |
|
| 230 | - * @param int|null $event_id |
|
| 231 | - * @param int $offset |
|
| 232 | - * @param int $limit |
|
| 233 | - * @param array $question_labels the IDs for all the questions which were answered by someone in this selection |
|
| 234 | - * @param array $query_params for using where querying the model |
|
| 235 | - * @return array top-level keys are numeric, next-level keys are column headers |
|
| 236 | - * @throws \EE_Error |
|
| 237 | - */ |
|
| 238 | - public function get_csv_data_for($event_id, $offset, $limit, $question_labels, $query_params) |
|
| 239 | - { |
|
| 240 | - $reg_fields_to_include = array( |
|
| 241 | - 'TXN_ID', |
|
| 242 | - 'ATT_ID', |
|
| 243 | - 'REG_ID', |
|
| 244 | - 'REG_date', |
|
| 245 | - 'REG_code', |
|
| 246 | - 'REG_count', |
|
| 247 | - 'REG_final_price', |
|
| 248 | - ); |
|
| 249 | - $att_fields_to_include = array( |
|
| 250 | - 'ATT_fname', |
|
| 251 | - 'ATT_lname', |
|
| 252 | - 'ATT_email', |
|
| 253 | - 'ATT_address', |
|
| 254 | - 'ATT_address2', |
|
| 255 | - 'ATT_city', |
|
| 256 | - 'STA_ID', |
|
| 257 | - 'CNT_ISO', |
|
| 258 | - 'ATT_zip', |
|
| 259 | - 'ATT_phone', |
|
| 260 | - ); |
|
| 261 | - $registrations_csv_ready_array = array(); |
|
| 262 | - $reg_model = EE_Registry::instance()->load_model('Registration'); |
|
| 263 | - $query_params['limit'] = array($offset, $limit); |
|
| 264 | - $registration_rows = $reg_model->get_all_wpdb_results($query_params); |
|
| 265 | - $registration_ids = array(); |
|
| 266 | - foreach ($registration_rows as $reg_row) { |
|
| 267 | - $registration_ids[] = intval($reg_row['Registration.REG_ID']); |
|
| 268 | - } |
|
| 269 | - foreach ($registration_rows as $reg_row) { |
|
| 270 | - if (is_array($reg_row)) { |
|
| 271 | - $reg_csv_array = array(); |
|
| 272 | - if (! $event_id) { |
|
| 273 | - // get the event's name and Id |
|
| 274 | - $reg_csv_array[ (string) __('Event', 'event_espresso') ] = sprintf( |
|
| 275 | - /* translators: 1: event name, 2: event ID */ |
|
| 276 | - __('%1$s (%2$s)', 'event_espresso'), |
|
| 277 | - EEH_Export::prepare_value_from_db_for_display( |
|
| 278 | - EEM_Event::instance(), |
|
| 279 | - 'EVT_name', |
|
| 280 | - $reg_row['Event_CPT.post_title'] |
|
| 281 | - ), |
|
| 282 | - $reg_row['Event_CPT.ID'] |
|
| 283 | - ); |
|
| 284 | - } |
|
| 285 | - $is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false; |
|
| 286 | - /*@var $reg_row EE_Registration */ |
|
| 287 | - foreach ($reg_fields_to_include as $field_name) { |
|
| 288 | - $field = $reg_model->field_settings_for($field_name); |
|
| 289 | - if ($field_name == 'REG_final_price') { |
|
| 290 | - $value = EEH_Export::prepare_value_from_db_for_display( |
|
| 291 | - $reg_model, |
|
| 292 | - $field_name, |
|
| 293 | - $reg_row['Registration.REG_final_price'], |
|
| 294 | - 'localized_float' |
|
| 295 | - ); |
|
| 296 | - } elseif ($field_name == 'REG_count') { |
|
| 297 | - $value = sprintf( |
|
| 298 | - /* translators: 1: number of registration in group (REG_count), 2: registration group size (REG_group_size) */ |
|
| 299 | - __('%1$s of %2$s', 'event_espresso'), |
|
| 300 | - EEH_Export::prepare_value_from_db_for_display( |
|
| 301 | - $reg_model, |
|
| 302 | - 'REG_count', |
|
| 303 | - $reg_row['Registration.REG_count'] |
|
| 304 | - ), |
|
| 305 | - EEH_Export::prepare_value_from_db_for_display( |
|
| 306 | - $reg_model, |
|
| 307 | - 'REG_group_size', |
|
| 308 | - $reg_row['Registration.REG_group_size'] |
|
| 309 | - ) |
|
| 310 | - ); |
|
| 311 | - } elseif ($field_name == 'REG_date') { |
|
| 312 | - $value = EEH_Export::prepare_value_from_db_for_display( |
|
| 313 | - $reg_model, |
|
| 314 | - $field_name, |
|
| 315 | - $reg_row['Registration.REG_date'], |
|
| 316 | - 'no_html' |
|
| 317 | - ); |
|
| 318 | - } else { |
|
| 319 | - $value = EEH_Export::prepare_value_from_db_for_display( |
|
| 320 | - $reg_model, |
|
| 321 | - $field_name, |
|
| 322 | - $reg_row[ $field->get_qualified_column() ] |
|
| 323 | - ); |
|
| 324 | - } |
|
| 325 | - $reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = $value; |
|
| 326 | - if ($field_name == 'REG_final_price') { |
|
| 327 | - // add a column named Currency after the final price |
|
| 328 | - $reg_csv_array[ (string) __("Currency", "event_espresso") ] = \EE_Config::instance()->currency->code; |
|
| 329 | - } |
|
| 330 | - } |
|
| 331 | - // get pretty status |
|
| 332 | - $stati = EEM_Status::instance()->localized_status( |
|
| 333 | - array( |
|
| 334 | - $reg_row['Registration.STS_ID'] => __('unknown', 'event_espresso'), |
|
| 335 | - $reg_row['TransactionTable.STS_ID'] => __('unknown', 'event_espresso'), |
|
| 336 | - ), |
|
| 337 | - false, |
|
| 338 | - 'sentence' |
|
| 339 | - ); |
|
| 340 | - $reg_csv_array[ (string) __("Registration Status", 'event_espresso') ] = $stati[ $reg_row['Registration.STS_ID'] ]; |
|
| 341 | - // get pretty transaction status |
|
| 342 | - $reg_csv_array[ (string) __("Transaction Status", 'event_espresso') ] = $stati[ $reg_row['TransactionTable.STS_ID'] ]; |
|
| 343 | - $reg_csv_array[ (string) __('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg |
|
| 344 | - ? EEH_Export::prepare_value_from_db_for_display( |
|
| 345 | - EEM_Transaction::instance(), |
|
| 346 | - 'TXN_total', |
|
| 347 | - $reg_row['TransactionTable.TXN_total'], |
|
| 348 | - 'localized_float' |
|
| 349 | - ) : '0.00'; |
|
| 350 | - $reg_csv_array[ (string) __('Amount Paid', 'event_espresso') ] = $is_primary_reg |
|
| 351 | - ? EEH_Export::prepare_value_from_db_for_display( |
|
| 352 | - EEM_Transaction::instance(), |
|
| 353 | - 'TXN_paid', |
|
| 354 | - $reg_row['TransactionTable.TXN_paid'], |
|
| 355 | - 'localized_float' |
|
| 356 | - ) : '0.00'; |
|
| 357 | - $payment_methods = array(); |
|
| 358 | - $gateway_txn_ids_etc = array(); |
|
| 359 | - $payment_times = array(); |
|
| 360 | - if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) { |
|
| 361 | - $payments_info = EEM_Payment::instance()->get_all_wpdb_results( |
|
| 362 | - array( |
|
| 363 | - array( |
|
| 364 | - 'TXN_ID' => $reg_row['TransactionTable.TXN_ID'], |
|
| 365 | - 'STS_ID' => EEM_Payment::status_id_approved, |
|
| 366 | - ), |
|
| 367 | - 'force_join' => array('Payment_Method'), |
|
| 368 | - ), |
|
| 369 | - ARRAY_A, |
|
| 370 | - 'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time' |
|
| 371 | - ); |
|
| 372 | - foreach ($payments_info as $payment_method_and_gateway_txn_id) { |
|
| 373 | - $payment_methods[] = isset($payment_method_and_gateway_txn_id['name']) |
|
| 374 | - ? $payment_method_and_gateway_txn_id['name'] : __('Unknown', 'event_espresso'); |
|
| 375 | - $gateway_txn_ids_etc[] = isset($payment_method_and_gateway_txn_id['gateway_txn_id']) |
|
| 376 | - ? $payment_method_and_gateway_txn_id['gateway_txn_id'] : ''; |
|
| 377 | - $payment_times[] = isset($payment_method_and_gateway_txn_id['payment_time']) |
|
| 378 | - ? $payment_method_and_gateway_txn_id['payment_time'] : ''; |
|
| 379 | - } |
|
| 380 | - } |
|
| 381 | - $reg_csv_array[ (string) __('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times); |
|
| 382 | - $reg_csv_array[ (string) __('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods); |
|
| 383 | - $reg_csv_array[ (string) __('Gateway Transaction ID(s)', 'event_espresso') ] = implode( |
|
| 384 | - ',', |
|
| 385 | - $gateway_txn_ids_etc |
|
| 386 | - ); |
|
| 387 | - // get whether or not the user has checked in |
|
| 388 | - $reg_csv_array[ (string) __("Check-Ins", "event_espresso") ] = $reg_model->count_related( |
|
| 389 | - $reg_row['Registration.REG_ID'], |
|
| 390 | - 'Checkin' |
|
| 391 | - ); |
|
| 392 | - // get ticket of registration and its price |
|
| 393 | - $ticket_model = EE_Registry::instance()->load_model('Ticket'); |
|
| 394 | - if ($reg_row['Ticket.TKT_ID']) { |
|
| 395 | - $ticket_name = EEH_Export::prepare_value_from_db_for_display( |
|
| 396 | - $ticket_model, |
|
| 397 | - 'TKT_name', |
|
| 398 | - $reg_row['Ticket.TKT_name'] |
|
| 399 | - ); |
|
| 400 | - $datetimes_strings = array(); |
|
| 401 | - foreach (EEM_Datetime::instance()->get_all_wpdb_results( |
|
| 402 | - array( |
|
| 403 | - array('Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']), |
|
| 404 | - 'order_by' => array('DTT_EVT_start' => 'ASC'), |
|
| 405 | - 'default_where_conditions' => 'none', |
|
| 406 | - ) |
|
| 407 | - ) as $datetime) { |
|
| 408 | - $datetimes_strings[] = EEH_Export::prepare_value_from_db_for_display( |
|
| 409 | - EEM_Datetime::instance(), |
|
| 410 | - 'DTT_EVT_start', |
|
| 411 | - $datetime['Datetime.DTT_EVT_start'] |
|
| 412 | - ); |
|
| 413 | - } |
|
| 414 | - } else { |
|
| 415 | - $ticket_name = __('Unknown', 'event_espresso'); |
|
| 416 | - $datetimes_strings = array(__('Unknown', 'event_espresso')); |
|
| 417 | - } |
|
| 418 | - $reg_csv_array[ (string) $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name; |
|
| 419 | - $reg_csv_array[ (string) __("Datetimes of Ticket", "event_espresso") ] = implode(", ", $datetimes_strings); |
|
| 420 | - // get datetime(s) of registration |
|
| 421 | - // add attendee columns |
|
| 422 | - foreach ($att_fields_to_include as $att_field_name) { |
|
| 423 | - $field_obj = EEM_Attendee::instance()->field_settings_for($att_field_name); |
|
| 424 | - if ($reg_row['Attendee_CPT.ID']) { |
|
| 425 | - if ($att_field_name == 'STA_ID') { |
|
| 426 | - $value = EEM_State::instance()->get_var( |
|
| 427 | - array(array('STA_ID' => $reg_row['Attendee_Meta.STA_ID'])), |
|
| 428 | - 'STA_name' |
|
| 429 | - ); |
|
| 430 | - } elseif ($att_field_name == 'CNT_ISO') { |
|
| 431 | - $value = EEM_Country::instance()->get_var( |
|
| 432 | - array(array('CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO'])), |
|
| 433 | - 'CNT_name' |
|
| 434 | - ); |
|
| 435 | - } else { |
|
| 436 | - $value = EEH_Export::prepare_value_from_db_for_display( |
|
| 437 | - EEM_Attendee::instance(), |
|
| 438 | - $att_field_name, |
|
| 439 | - $reg_row[ $field_obj->get_qualified_column() ] |
|
| 440 | - ); |
|
| 441 | - } |
|
| 442 | - } else { |
|
| 443 | - $value = ''; |
|
| 444 | - } |
|
| 445 | - $reg_csv_array[ EEH_Export::get_column_name_for_field($field_obj) ] = $value; |
|
| 446 | - } |
|
| 447 | - // make sure each registration has the same questions in the same order |
|
| 448 | - foreach ($question_labels as $question_label) { |
|
| 449 | - if (! isset($reg_csv_array[ $question_label ])) { |
|
| 450 | - $reg_csv_array[ $question_label ] = null; |
|
| 451 | - } |
|
| 452 | - } |
|
| 453 | - $answers = EEM_Answer::instance()->get_all_wpdb_results(array( |
|
| 454 | - array('REG_ID' => $reg_row['Registration.REG_ID']), |
|
| 455 | - 'force_join' => array('Question'), |
|
| 456 | - )); |
|
| 457 | - // now fill out the questions THEY answered |
|
| 458 | - foreach ($answers as $answer_row) { |
|
| 459 | - if ($answer_row['Question.QST_system']) { |
|
| 460 | - // it's an answer to a system question. That was already displayed as part of the attendee |
|
| 461 | - // fields, so don't write it out again thanks. |
|
| 462 | - continue; |
|
| 463 | - } |
|
| 464 | - if ($answer_row['Question.QST_ID']) { |
|
| 465 | - $question_label = EEH_Export::prepare_value_from_db_for_display( |
|
| 466 | - EEM_Question::instance(), |
|
| 467 | - 'QST_admin_label', |
|
| 468 | - $answer_row['Question.QST_admin_label'] |
|
| 469 | - ); |
|
| 470 | - } else { |
|
| 471 | - $question_label = sprintf(__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']); |
|
| 472 | - } |
|
| 473 | - if (isset($answer_row['Question.QST_type']) |
|
| 474 | - && $answer_row['Question.QST_type'] == EEM_Question::QST_type_state |
|
| 475 | - ) { |
|
| 476 | - $reg_csv_array[ $question_label ] = EEM_State::instance()->get_state_name_by_ID( |
|
| 477 | - $answer_row['Answer.ANS_value'] |
|
| 478 | - ); |
|
| 479 | - } else { |
|
| 480 | - // this isn't for html, so don't show html entities |
|
| 481 | - $reg_csv_array[ $question_label ] = html_entity_decode( |
|
| 482 | - EEH_Export::prepare_value_from_db_for_display( |
|
| 483 | - EEM_Answer::instance(), |
|
| 484 | - 'ANS_value', |
|
| 485 | - $answer_row['Answer.ANS_value'] |
|
| 486 | - ) |
|
| 487 | - ); |
|
| 488 | - } |
|
| 489 | - } |
|
| 227 | + /** |
|
| 228 | + * Gets the csv data for a batch of registrations |
|
| 229 | + * |
|
| 230 | + * @param int|null $event_id |
|
| 231 | + * @param int $offset |
|
| 232 | + * @param int $limit |
|
| 233 | + * @param array $question_labels the IDs for all the questions which were answered by someone in this selection |
|
| 234 | + * @param array $query_params for using where querying the model |
|
| 235 | + * @return array top-level keys are numeric, next-level keys are column headers |
|
| 236 | + * @throws \EE_Error |
|
| 237 | + */ |
|
| 238 | + public function get_csv_data_for($event_id, $offset, $limit, $question_labels, $query_params) |
|
| 239 | + { |
|
| 240 | + $reg_fields_to_include = array( |
|
| 241 | + 'TXN_ID', |
|
| 242 | + 'ATT_ID', |
|
| 243 | + 'REG_ID', |
|
| 244 | + 'REG_date', |
|
| 245 | + 'REG_code', |
|
| 246 | + 'REG_count', |
|
| 247 | + 'REG_final_price', |
|
| 248 | + ); |
|
| 249 | + $att_fields_to_include = array( |
|
| 250 | + 'ATT_fname', |
|
| 251 | + 'ATT_lname', |
|
| 252 | + 'ATT_email', |
|
| 253 | + 'ATT_address', |
|
| 254 | + 'ATT_address2', |
|
| 255 | + 'ATT_city', |
|
| 256 | + 'STA_ID', |
|
| 257 | + 'CNT_ISO', |
|
| 258 | + 'ATT_zip', |
|
| 259 | + 'ATT_phone', |
|
| 260 | + ); |
|
| 261 | + $registrations_csv_ready_array = array(); |
|
| 262 | + $reg_model = EE_Registry::instance()->load_model('Registration'); |
|
| 263 | + $query_params['limit'] = array($offset, $limit); |
|
| 264 | + $registration_rows = $reg_model->get_all_wpdb_results($query_params); |
|
| 265 | + $registration_ids = array(); |
|
| 266 | + foreach ($registration_rows as $reg_row) { |
|
| 267 | + $registration_ids[] = intval($reg_row['Registration.REG_ID']); |
|
| 268 | + } |
|
| 269 | + foreach ($registration_rows as $reg_row) { |
|
| 270 | + if (is_array($reg_row)) { |
|
| 271 | + $reg_csv_array = array(); |
|
| 272 | + if (! $event_id) { |
|
| 273 | + // get the event's name and Id |
|
| 274 | + $reg_csv_array[ (string) __('Event', 'event_espresso') ] = sprintf( |
|
| 275 | + /* translators: 1: event name, 2: event ID */ |
|
| 276 | + __('%1$s (%2$s)', 'event_espresso'), |
|
| 277 | + EEH_Export::prepare_value_from_db_for_display( |
|
| 278 | + EEM_Event::instance(), |
|
| 279 | + 'EVT_name', |
|
| 280 | + $reg_row['Event_CPT.post_title'] |
|
| 281 | + ), |
|
| 282 | + $reg_row['Event_CPT.ID'] |
|
| 283 | + ); |
|
| 284 | + } |
|
| 285 | + $is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false; |
|
| 286 | + /*@var $reg_row EE_Registration */ |
|
| 287 | + foreach ($reg_fields_to_include as $field_name) { |
|
| 288 | + $field = $reg_model->field_settings_for($field_name); |
|
| 289 | + if ($field_name == 'REG_final_price') { |
|
| 290 | + $value = EEH_Export::prepare_value_from_db_for_display( |
|
| 291 | + $reg_model, |
|
| 292 | + $field_name, |
|
| 293 | + $reg_row['Registration.REG_final_price'], |
|
| 294 | + 'localized_float' |
|
| 295 | + ); |
|
| 296 | + } elseif ($field_name == 'REG_count') { |
|
| 297 | + $value = sprintf( |
|
| 298 | + /* translators: 1: number of registration in group (REG_count), 2: registration group size (REG_group_size) */ |
|
| 299 | + __('%1$s of %2$s', 'event_espresso'), |
|
| 300 | + EEH_Export::prepare_value_from_db_for_display( |
|
| 301 | + $reg_model, |
|
| 302 | + 'REG_count', |
|
| 303 | + $reg_row['Registration.REG_count'] |
|
| 304 | + ), |
|
| 305 | + EEH_Export::prepare_value_from_db_for_display( |
|
| 306 | + $reg_model, |
|
| 307 | + 'REG_group_size', |
|
| 308 | + $reg_row['Registration.REG_group_size'] |
|
| 309 | + ) |
|
| 310 | + ); |
|
| 311 | + } elseif ($field_name == 'REG_date') { |
|
| 312 | + $value = EEH_Export::prepare_value_from_db_for_display( |
|
| 313 | + $reg_model, |
|
| 314 | + $field_name, |
|
| 315 | + $reg_row['Registration.REG_date'], |
|
| 316 | + 'no_html' |
|
| 317 | + ); |
|
| 318 | + } else { |
|
| 319 | + $value = EEH_Export::prepare_value_from_db_for_display( |
|
| 320 | + $reg_model, |
|
| 321 | + $field_name, |
|
| 322 | + $reg_row[ $field->get_qualified_column() ] |
|
| 323 | + ); |
|
| 324 | + } |
|
| 325 | + $reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = $value; |
|
| 326 | + if ($field_name == 'REG_final_price') { |
|
| 327 | + // add a column named Currency after the final price |
|
| 328 | + $reg_csv_array[ (string) __("Currency", "event_espresso") ] = \EE_Config::instance()->currency->code; |
|
| 329 | + } |
|
| 330 | + } |
|
| 331 | + // get pretty status |
|
| 332 | + $stati = EEM_Status::instance()->localized_status( |
|
| 333 | + array( |
|
| 334 | + $reg_row['Registration.STS_ID'] => __('unknown', 'event_espresso'), |
|
| 335 | + $reg_row['TransactionTable.STS_ID'] => __('unknown', 'event_espresso'), |
|
| 336 | + ), |
|
| 337 | + false, |
|
| 338 | + 'sentence' |
|
| 339 | + ); |
|
| 340 | + $reg_csv_array[ (string) __("Registration Status", 'event_espresso') ] = $stati[ $reg_row['Registration.STS_ID'] ]; |
|
| 341 | + // get pretty transaction status |
|
| 342 | + $reg_csv_array[ (string) __("Transaction Status", 'event_espresso') ] = $stati[ $reg_row['TransactionTable.STS_ID'] ]; |
|
| 343 | + $reg_csv_array[ (string) __('Transaction Amount Due', 'event_espresso') ] = $is_primary_reg |
|
| 344 | + ? EEH_Export::prepare_value_from_db_for_display( |
|
| 345 | + EEM_Transaction::instance(), |
|
| 346 | + 'TXN_total', |
|
| 347 | + $reg_row['TransactionTable.TXN_total'], |
|
| 348 | + 'localized_float' |
|
| 349 | + ) : '0.00'; |
|
| 350 | + $reg_csv_array[ (string) __('Amount Paid', 'event_espresso') ] = $is_primary_reg |
|
| 351 | + ? EEH_Export::prepare_value_from_db_for_display( |
|
| 352 | + EEM_Transaction::instance(), |
|
| 353 | + 'TXN_paid', |
|
| 354 | + $reg_row['TransactionTable.TXN_paid'], |
|
| 355 | + 'localized_float' |
|
| 356 | + ) : '0.00'; |
|
| 357 | + $payment_methods = array(); |
|
| 358 | + $gateway_txn_ids_etc = array(); |
|
| 359 | + $payment_times = array(); |
|
| 360 | + if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) { |
|
| 361 | + $payments_info = EEM_Payment::instance()->get_all_wpdb_results( |
|
| 362 | + array( |
|
| 363 | + array( |
|
| 364 | + 'TXN_ID' => $reg_row['TransactionTable.TXN_ID'], |
|
| 365 | + 'STS_ID' => EEM_Payment::status_id_approved, |
|
| 366 | + ), |
|
| 367 | + 'force_join' => array('Payment_Method'), |
|
| 368 | + ), |
|
| 369 | + ARRAY_A, |
|
| 370 | + 'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time' |
|
| 371 | + ); |
|
| 372 | + foreach ($payments_info as $payment_method_and_gateway_txn_id) { |
|
| 373 | + $payment_methods[] = isset($payment_method_and_gateway_txn_id['name']) |
|
| 374 | + ? $payment_method_and_gateway_txn_id['name'] : __('Unknown', 'event_espresso'); |
|
| 375 | + $gateway_txn_ids_etc[] = isset($payment_method_and_gateway_txn_id['gateway_txn_id']) |
|
| 376 | + ? $payment_method_and_gateway_txn_id['gateway_txn_id'] : ''; |
|
| 377 | + $payment_times[] = isset($payment_method_and_gateway_txn_id['payment_time']) |
|
| 378 | + ? $payment_method_and_gateway_txn_id['payment_time'] : ''; |
|
| 379 | + } |
|
| 380 | + } |
|
| 381 | + $reg_csv_array[ (string) __('Payment Date(s)', 'event_espresso') ] = implode(',', $payment_times); |
|
| 382 | + $reg_csv_array[ (string) __('Payment Method(s)', 'event_espresso') ] = implode(",", $payment_methods); |
|
| 383 | + $reg_csv_array[ (string) __('Gateway Transaction ID(s)', 'event_espresso') ] = implode( |
|
| 384 | + ',', |
|
| 385 | + $gateway_txn_ids_etc |
|
| 386 | + ); |
|
| 387 | + // get whether or not the user has checked in |
|
| 388 | + $reg_csv_array[ (string) __("Check-Ins", "event_espresso") ] = $reg_model->count_related( |
|
| 389 | + $reg_row['Registration.REG_ID'], |
|
| 390 | + 'Checkin' |
|
| 391 | + ); |
|
| 392 | + // get ticket of registration and its price |
|
| 393 | + $ticket_model = EE_Registry::instance()->load_model('Ticket'); |
|
| 394 | + if ($reg_row['Ticket.TKT_ID']) { |
|
| 395 | + $ticket_name = EEH_Export::prepare_value_from_db_for_display( |
|
| 396 | + $ticket_model, |
|
| 397 | + 'TKT_name', |
|
| 398 | + $reg_row['Ticket.TKT_name'] |
|
| 399 | + ); |
|
| 400 | + $datetimes_strings = array(); |
|
| 401 | + foreach (EEM_Datetime::instance()->get_all_wpdb_results( |
|
| 402 | + array( |
|
| 403 | + array('Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']), |
|
| 404 | + 'order_by' => array('DTT_EVT_start' => 'ASC'), |
|
| 405 | + 'default_where_conditions' => 'none', |
|
| 406 | + ) |
|
| 407 | + ) as $datetime) { |
|
| 408 | + $datetimes_strings[] = EEH_Export::prepare_value_from_db_for_display( |
|
| 409 | + EEM_Datetime::instance(), |
|
| 410 | + 'DTT_EVT_start', |
|
| 411 | + $datetime['Datetime.DTT_EVT_start'] |
|
| 412 | + ); |
|
| 413 | + } |
|
| 414 | + } else { |
|
| 415 | + $ticket_name = __('Unknown', 'event_espresso'); |
|
| 416 | + $datetimes_strings = array(__('Unknown', 'event_espresso')); |
|
| 417 | + } |
|
| 418 | + $reg_csv_array[ (string) $ticket_model->field_settings_for('TKT_name')->get_nicename() ] = $ticket_name; |
|
| 419 | + $reg_csv_array[ (string) __("Datetimes of Ticket", "event_espresso") ] = implode(", ", $datetimes_strings); |
|
| 420 | + // get datetime(s) of registration |
|
| 421 | + // add attendee columns |
|
| 422 | + foreach ($att_fields_to_include as $att_field_name) { |
|
| 423 | + $field_obj = EEM_Attendee::instance()->field_settings_for($att_field_name); |
|
| 424 | + if ($reg_row['Attendee_CPT.ID']) { |
|
| 425 | + if ($att_field_name == 'STA_ID') { |
|
| 426 | + $value = EEM_State::instance()->get_var( |
|
| 427 | + array(array('STA_ID' => $reg_row['Attendee_Meta.STA_ID'])), |
|
| 428 | + 'STA_name' |
|
| 429 | + ); |
|
| 430 | + } elseif ($att_field_name == 'CNT_ISO') { |
|
| 431 | + $value = EEM_Country::instance()->get_var( |
|
| 432 | + array(array('CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO'])), |
|
| 433 | + 'CNT_name' |
|
| 434 | + ); |
|
| 435 | + } else { |
|
| 436 | + $value = EEH_Export::prepare_value_from_db_for_display( |
|
| 437 | + EEM_Attendee::instance(), |
|
| 438 | + $att_field_name, |
|
| 439 | + $reg_row[ $field_obj->get_qualified_column() ] |
|
| 440 | + ); |
|
| 441 | + } |
|
| 442 | + } else { |
|
| 443 | + $value = ''; |
|
| 444 | + } |
|
| 445 | + $reg_csv_array[ EEH_Export::get_column_name_for_field($field_obj) ] = $value; |
|
| 446 | + } |
|
| 447 | + // make sure each registration has the same questions in the same order |
|
| 448 | + foreach ($question_labels as $question_label) { |
|
| 449 | + if (! isset($reg_csv_array[ $question_label ])) { |
|
| 450 | + $reg_csv_array[ $question_label ] = null; |
|
| 451 | + } |
|
| 452 | + } |
|
| 453 | + $answers = EEM_Answer::instance()->get_all_wpdb_results(array( |
|
| 454 | + array('REG_ID' => $reg_row['Registration.REG_ID']), |
|
| 455 | + 'force_join' => array('Question'), |
|
| 456 | + )); |
|
| 457 | + // now fill out the questions THEY answered |
|
| 458 | + foreach ($answers as $answer_row) { |
|
| 459 | + if ($answer_row['Question.QST_system']) { |
|
| 460 | + // it's an answer to a system question. That was already displayed as part of the attendee |
|
| 461 | + // fields, so don't write it out again thanks. |
|
| 462 | + continue; |
|
| 463 | + } |
|
| 464 | + if ($answer_row['Question.QST_ID']) { |
|
| 465 | + $question_label = EEH_Export::prepare_value_from_db_for_display( |
|
| 466 | + EEM_Question::instance(), |
|
| 467 | + 'QST_admin_label', |
|
| 468 | + $answer_row['Question.QST_admin_label'] |
|
| 469 | + ); |
|
| 470 | + } else { |
|
| 471 | + $question_label = sprintf(__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']); |
|
| 472 | + } |
|
| 473 | + if (isset($answer_row['Question.QST_type']) |
|
| 474 | + && $answer_row['Question.QST_type'] == EEM_Question::QST_type_state |
|
| 475 | + ) { |
|
| 476 | + $reg_csv_array[ $question_label ] = EEM_State::instance()->get_state_name_by_ID( |
|
| 477 | + $answer_row['Answer.ANS_value'] |
|
| 478 | + ); |
|
| 479 | + } else { |
|
| 480 | + // this isn't for html, so don't show html entities |
|
| 481 | + $reg_csv_array[ $question_label ] = html_entity_decode( |
|
| 482 | + EEH_Export::prepare_value_from_db_for_display( |
|
| 483 | + EEM_Answer::instance(), |
|
| 484 | + 'ANS_value', |
|
| 485 | + $answer_row['Answer.ANS_value'] |
|
| 486 | + ) |
|
| 487 | + ); |
|
| 488 | + } |
|
| 489 | + } |
|
| 490 | 490 | |
| 491 | - /** |
|
| 492 | - * Filter to change the contents of each row of the registrations report CSV file. |
|
| 493 | - * This can be used to add or remote columns from the CSV file, or change their values. |
|
| 494 | - * Note when using: all rows in the CSV should have the same columns. |
|
| 495 | - * @param array $reg_csv_array keys are the column names, values are their cell values |
|
| 496 | - * @param array $reg_row one entry from EEM_Registration::get_all_wpdb_results() |
|
| 497 | - */ |
|
| 498 | - $registrations_csv_ready_array[] = apply_filters( |
|
| 499 | - 'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array', |
|
| 500 | - $reg_csv_array, |
|
| 501 | - $reg_row |
|
| 502 | - ); |
|
| 503 | - } |
|
| 504 | - } |
|
| 505 | - // if we couldn't export anything, we want to at least show the column headers |
|
| 506 | - if (empty($registrations_csv_ready_array)) { |
|
| 507 | - $reg_csv_array = array(); |
|
| 508 | - $model_and_fields_to_include = array( |
|
| 509 | - 'Registration' => $reg_fields_to_include, |
|
| 510 | - 'Attendee' => $att_fields_to_include, |
|
| 511 | - ); |
|
| 512 | - foreach ($model_and_fields_to_include as $model_name => $field_list) { |
|
| 513 | - $model = EE_Registry::instance()->load_model($model_name); |
|
| 514 | - foreach ($field_list as $field_name) { |
|
| 515 | - $field = $model->field_settings_for($field_name); |
|
| 516 | - $reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = null; |
|
| 517 | - } |
|
| 518 | - } |
|
| 519 | - $registrations_csv_ready_array[] = $reg_csv_array; |
|
| 520 | - } |
|
| 521 | - return $registrations_csv_ready_array; |
|
| 522 | - } |
|
| 491 | + /** |
|
| 492 | + * Filter to change the contents of each row of the registrations report CSV file. |
|
| 493 | + * This can be used to add or remote columns from the CSV file, or change their values. |
|
| 494 | + * Note when using: all rows in the CSV should have the same columns. |
|
| 495 | + * @param array $reg_csv_array keys are the column names, values are their cell values |
|
| 496 | + * @param array $reg_row one entry from EEM_Registration::get_all_wpdb_results() |
|
| 497 | + */ |
|
| 498 | + $registrations_csv_ready_array[] = apply_filters( |
|
| 499 | + 'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array', |
|
| 500 | + $reg_csv_array, |
|
| 501 | + $reg_row |
|
| 502 | + ); |
|
| 503 | + } |
|
| 504 | + } |
|
| 505 | + // if we couldn't export anything, we want to at least show the column headers |
|
| 506 | + if (empty($registrations_csv_ready_array)) { |
|
| 507 | + $reg_csv_array = array(); |
|
| 508 | + $model_and_fields_to_include = array( |
|
| 509 | + 'Registration' => $reg_fields_to_include, |
|
| 510 | + 'Attendee' => $att_fields_to_include, |
|
| 511 | + ); |
|
| 512 | + foreach ($model_and_fields_to_include as $model_name => $field_list) { |
|
| 513 | + $model = EE_Registry::instance()->load_model($model_name); |
|
| 514 | + foreach ($field_list as $field_name) { |
|
| 515 | + $field = $model->field_settings_for($field_name); |
|
| 516 | + $reg_csv_array[ EEH_Export::get_column_name_for_field($field) ] = null; |
|
| 517 | + } |
|
| 518 | + } |
|
| 519 | + $registrations_csv_ready_array[] = $reg_csv_array; |
|
| 520 | + } |
|
| 521 | + return $registrations_csv_ready_array; |
|
| 522 | + } |
|
| 523 | 523 | |
| 524 | 524 | |
| 525 | - /** |
|
| 526 | - * Counts total unit to process |
|
| 527 | - * |
|
| 528 | - * @deprecated since 4.9.19 |
|
| 529 | - * @param int|array $event_id |
|
| 530 | - * @return int |
|
| 531 | - */ |
|
| 532 | - public function count_units_to_process($event_id) |
|
| 533 | - { |
|
| 534 | - // use the legacy filter |
|
| 535 | - if ($event_id) { |
|
| 536 | - $query_params[0]['EVT_ID'] = $event_id; |
|
| 537 | - } else { |
|
| 538 | - $query_params['force_join'][] = 'Event'; |
|
| 539 | - } |
|
| 540 | - return \EEM_Registration::instance()->count($query_params); |
|
| 541 | - } |
|
| 525 | + /** |
|
| 526 | + * Counts total unit to process |
|
| 527 | + * |
|
| 528 | + * @deprecated since 4.9.19 |
|
| 529 | + * @param int|array $event_id |
|
| 530 | + * @return int |
|
| 531 | + */ |
|
| 532 | + public function count_units_to_process($event_id) |
|
| 533 | + { |
|
| 534 | + // use the legacy filter |
|
| 535 | + if ($event_id) { |
|
| 536 | + $query_params[0]['EVT_ID'] = $event_id; |
|
| 537 | + } else { |
|
| 538 | + $query_params['force_join'][] = 'Event'; |
|
| 539 | + } |
|
| 540 | + return \EEM_Registration::instance()->count($query_params); |
|
| 541 | + } |
|
| 542 | 542 | |
| 543 | 543 | |
| 544 | - /** |
|
| 545 | - * Performs any clean-up logic when we know the job is completed. |
|
| 546 | - * In this case, we delete the temporary file |
|
| 547 | - * |
|
| 548 | - * @param JobParameters $job_parameters |
|
| 549 | - * @return boolean |
|
| 550 | - */ |
|
| 551 | - public function cleanup_job(JobParameters $job_parameters) |
|
| 552 | - { |
|
| 553 | - $this->_file_helper->delete( |
|
| 554 | - \EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')), |
|
| 555 | - true, |
|
| 556 | - 'd' |
|
| 557 | - ); |
|
| 558 | - return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso')); |
|
| 559 | - } |
|
| 544 | + /** |
|
| 545 | + * Performs any clean-up logic when we know the job is completed. |
|
| 546 | + * In this case, we delete the temporary file |
|
| 547 | + * |
|
| 548 | + * @param JobParameters $job_parameters |
|
| 549 | + * @return boolean |
|
| 550 | + */ |
|
| 551 | + public function cleanup_job(JobParameters $job_parameters) |
|
| 552 | + { |
|
| 553 | + $this->_file_helper->delete( |
|
| 554 | + \EEH_File::remove_filename_from_filepath($job_parameters->extra_datum('filepath')), |
|
| 555 | + true, |
|
| 556 | + 'd' |
|
| 557 | + ); |
|
| 558 | + return new JobStepResponse($job_parameters, __('Cleaned up temporary file', 'event_espresso')); |
|
| 559 | + } |
|
| 560 | 560 | } |
@@ -227,7 +227,7 @@ |
||
| 227 | 227 | * _get_table_filters |
| 228 | 228 | * |
| 229 | 229 | * @access protected |
| 230 | - * @return array |
|
| 230 | + * @return string[] |
|
| 231 | 231 | */ |
| 232 | 232 | protected function _get_table_filters() |
| 233 | 233 | { |
@@ -1,5 +1,4 @@ |
||
| 1 | 1 | <?php use EventEspresso\core\exceptions\EntityNotFoundException; |
| 2 | - |
|
| 3 | 2 | use EventEspresso\core\exceptions\InvalidDataTypeException; |
| 4 | 3 | use EventEspresso\core\exceptions\InvalidInterfaceException; |
| 5 | 4 | |
@@ -805,7 +805,7 @@ discard block |
||
| 805 | 805 | * @since 4.5.0 |
| 806 | 806 | * |
| 807 | 807 | * @param string $meta_cap What meta capability is this mapping. |
| 808 | - * @param array $map_values array { |
|
| 808 | + * @param string[] $map_values array { |
|
| 809 | 809 | * //array of values that MUST match a count of 4. It's okay to send an empty string for |
| 810 | 810 | * capabilities that don't get mapped to. |
| 811 | 811 | * |
@@ -880,8 +880,8 @@ discard block |
||
| 880 | 880 | * @since 4.6.x |
| 881 | 881 | * |
| 882 | 882 | * @param $caps |
| 883 | - * @param $cap |
|
| 884 | - * @param $user_id |
|
| 883 | + * @param string $cap |
|
| 884 | + * @param integer $user_id |
|
| 885 | 885 | * @param $args |
| 886 | 886 | * |
| 887 | 887 | * @return array |
@@ -80,7 +80,7 @@ discard block |
||
| 80 | 80 | public static function instance() |
| 81 | 81 | { |
| 82 | 82 | // check if instantiated, and if not do so. |
| 83 | - if (! self::$_instance instanceof EE_Capabilities) { |
|
| 83 | + if ( ! self::$_instance instanceof EE_Capabilities) { |
|
| 84 | 84 | self::$_instance = new self(); |
| 85 | 85 | } |
| 86 | 86 | return self::$_instance; |
@@ -110,7 +110,7 @@ discard block |
||
| 110 | 110 | */ |
| 111 | 111 | public function init_caps($reset = false) |
| 112 | 112 | { |
| 113 | - if (! EE_Maintenance_Mode::instance()->models_can_query()) { |
|
| 113 | + if ( ! EE_Maintenance_Mode::instance()->models_can_query()) { |
|
| 114 | 114 | return false; |
| 115 | 115 | } |
| 116 | 116 | $this->reset = filter_var($reset, FILTER_VALIDATE_BOOLEAN); |
@@ -155,7 +155,7 @@ discard block |
||
| 155 | 155 | $this->_get_default_meta_caps_array() |
| 156 | 156 | ); |
| 157 | 157 | // add filter for map_meta_caps but only if models can query. |
| 158 | - if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) { |
|
| 158 | + if ( ! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) { |
|
| 159 | 159 | add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4); |
| 160 | 160 | } |
| 161 | 161 | } |
@@ -314,11 +314,11 @@ discard block |
||
| 314 | 314 | if (did_action('AHEE__EE_System__load_espresso_addons__complete')) { |
| 315 | 315 | // loop through our _meta_caps array |
| 316 | 316 | foreach ($this->_meta_caps as $meta_map) { |
| 317 | - if (! $meta_map instanceof EE_Meta_Capability_Map) { |
|
| 317 | + if ( ! $meta_map instanceof EE_Meta_Capability_Map) { |
|
| 318 | 318 | continue; |
| 319 | 319 | } |
| 320 | 320 | // don't load models if there is no object ID in the args |
| 321 | - if (! empty($args[0])) { |
|
| 321 | + if ( ! empty($args[0])) { |
|
| 322 | 322 | $meta_map->ensure_is_model(); |
| 323 | 323 | } |
| 324 | 324 | $caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args); |
@@ -652,7 +652,7 @@ discard block |
||
| 652 | 652 | public function addCaps(array $capabilities_to_add) |
| 653 | 653 | { |
| 654 | 654 | // don't do anything if the capabilities map can not be initialized |
| 655 | - if (! $this->setupCapabilitiesMap()) { |
|
| 655 | + if ( ! $this->setupCapabilitiesMap()) { |
|
| 656 | 656 | return false; |
| 657 | 657 | } |
| 658 | 658 | // and filter the array so others can get in on the fun during resets |
@@ -667,7 +667,7 @@ discard block |
||
| 667 | 667 | foreach ($capabilities_to_add as $role => $caps_for_role) { |
| 668 | 668 | if (is_array($caps_for_role)) { |
| 669 | 669 | foreach ($caps_for_role as $cap) { |
| 670 | - if (! $this->capHasBeenAddedToRole($role, $cap) |
|
| 670 | + if ( ! $this->capHasBeenAddedToRole($role, $cap) |
|
| 671 | 671 | && $this->add_cap_to_role($role, $cap, true, false) |
| 672 | 672 | ) { |
| 673 | 673 | $update_capabilities_map = true; |
@@ -693,7 +693,7 @@ discard block |
||
| 693 | 693 | public function removeCaps($caps_map) |
| 694 | 694 | { |
| 695 | 695 | // don't do anything if the capabilities map can not be initialized |
| 696 | - if (! $this->setupCapabilitiesMap()) { |
|
| 696 | + if ( ! $this->setupCapabilitiesMap()) { |
|
| 697 | 697 | return false; |
| 698 | 698 | } |
| 699 | 699 | $update_capabilities_map = false; |
@@ -752,7 +752,7 @@ discard block |
||
| 752 | 752 | $orig_role = $role; |
| 753 | 753 | $role = $role instanceof WP_Role ? $role : get_role($role); |
| 754 | 754 | // if the role isn't available then we create it. |
| 755 | - if (! $role instanceof WP_Role) { |
|
| 755 | + if ( ! $role instanceof WP_Role) { |
|
| 756 | 756 | // if a plugin wants to create a specific role name then they should create the role before |
| 757 | 757 | // EE_Capabilities does. Otherwise this function will create the role name from the slug: |
| 758 | 758 | // - removes any `ee_` namespacing from the start of the slug. |
@@ -763,12 +763,12 @@ discard block |
||
| 763 | 763 | } |
| 764 | 764 | if ($role instanceof WP_Role) { |
| 765 | 765 | // don't do anything if the capabilities map can not be initialized |
| 766 | - if (! $this->setupCapabilitiesMap()) { |
|
| 766 | + if ( ! $this->setupCapabilitiesMap()) { |
|
| 767 | 767 | return false; |
| 768 | 768 | } |
| 769 | - if (! $this->capHasBeenAddedToRole($role->name, $cap)) { |
|
| 769 | + if ( ! $this->capHasBeenAddedToRole($role->name, $cap)) { |
|
| 770 | 770 | $role->add_cap($cap, $grant); |
| 771 | - $this->capabilities_map[ $role->name ][] = $cap; |
|
| 771 | + $this->capabilities_map[$role->name][] = $cap; |
|
| 772 | 772 | $this->updateCapabilitiesMap($update_capabilities_map); |
| 773 | 773 | return true; |
| 774 | 774 | } |
@@ -792,14 +792,14 @@ discard block |
||
| 792 | 792 | public function remove_cap_from_role($role, $cap, $update_capabilities_map = true) |
| 793 | 793 | { |
| 794 | 794 | // don't do anything if the capabilities map can not be initialized |
| 795 | - if (! $this->setupCapabilitiesMap()) { |
|
| 795 | + if ( ! $this->setupCapabilitiesMap()) { |
|
| 796 | 796 | return false; |
| 797 | 797 | } |
| 798 | 798 | |
| 799 | 799 | $role = $role instanceof WP_Role ? $role : get_role($role); |
| 800 | 800 | if ($role instanceof WP_Role && $index = $this->capHasBeenAddedToRole($role->name, $cap, true)) { |
| 801 | 801 | $role->remove_cap($cap); |
| 802 | - unset($this->capabilities_map[ $role->name ][ $index ]); |
|
| 802 | + unset($this->capabilities_map[$role->name][$index]); |
|
| 803 | 803 | $this->updateCapabilitiesMap($update_capabilities_map); |
| 804 | 804 | return true; |
| 805 | 805 | } |
@@ -815,8 +815,8 @@ discard block |
||
| 815 | 815 | */ |
| 816 | 816 | private function capHasBeenAddedToRole($role_name = '', $cap = '', $get_index = false) |
| 817 | 817 | { |
| 818 | - if (isset($this->capabilities_map[ $role_name ]) |
|
| 819 | - && ($index = array_search($cap, $this->capabilities_map[ $role_name ], true)) !== false |
|
| 818 | + if (isset($this->capabilities_map[$role_name]) |
|
| 819 | + && ($index = array_search($cap, $this->capabilities_map[$role_name], true)) !== false |
|
| 820 | 820 | ) { |
| 821 | 821 | return $get_index ? $index : true; |
| 822 | 822 | } |
@@ -843,7 +843,7 @@ discard block |
||
| 843 | 843 | public function current_user_can($cap, $context, $id = 0) |
| 844 | 844 | { |
| 845 | 845 | // apply filters (both a global on just the cap, and context specific. Global overrides context specific) |
| 846 | - $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id); |
|
| 846 | + $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__'.$context, $cap, $id); |
|
| 847 | 847 | $filtered_cap = apply_filters( |
| 848 | 848 | 'FHEE__EE_Capabilities__current_user_can__cap', |
| 849 | 849 | $filtered_cap, |
@@ -871,7 +871,7 @@ discard block |
||
| 871 | 871 | public function user_can($user, $cap, $context, $id = 0) |
| 872 | 872 | { |
| 873 | 873 | // apply filters (both a global on just the cap, and context specific. Global overrides context specific) |
| 874 | - $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id); |
|
| 874 | + $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__'.$context, $cap, $user, $id); |
|
| 875 | 875 | $filtered_cap = apply_filters( |
| 876 | 876 | 'FHEE__EE_Capabilities__user_can__cap', |
| 877 | 877 | $filtered_cap, |
@@ -910,7 +910,7 @@ discard block |
||
| 910 | 910 | : current_user_can($blog_id, $cap); |
| 911 | 911 | // apply filters (both a global on just the cap, and context specific. Global overrides context specific) |
| 912 | 912 | $user_can = apply_filters( |
| 913 | - 'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context, |
|
| 913 | + 'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__'.$context, |
|
| 914 | 914 | $user_can, |
| 915 | 915 | $blog_id, |
| 916 | 916 | $cap, |
@@ -939,14 +939,14 @@ discard block |
||
| 939 | 939 | */ |
| 940 | 940 | public function get_ee_capabilities($role = 'administrator') |
| 941 | 941 | { |
| 942 | - if (! $this->initialized) { |
|
| 942 | + if ( ! $this->initialized) { |
|
| 943 | 943 | $this->init_caps(); |
| 944 | 944 | } |
| 945 | 945 | if (empty($role)) { |
| 946 | 946 | return $this->capabilities_map; |
| 947 | 947 | } |
| 948 | - return isset($this->capabilities_map[ $role ]) |
|
| 949 | - ? $this->capabilities_map[ $role ] |
|
| 948 | + return isset($this->capabilities_map[$role]) |
|
| 949 | + ? $this->capabilities_map[$role] |
|
| 950 | 950 | : array(); |
| 951 | 951 | } |
| 952 | 952 | |
@@ -977,7 +977,7 @@ discard block |
||
| 977 | 977 | 'event_espresso' |
| 978 | 978 | ), |
| 979 | 979 | '$reset', |
| 980 | - __METHOD__ . '()', |
|
| 980 | + __METHOD__.'()', |
|
| 981 | 981 | 'EE_Capabilities::init_caps()', |
| 982 | 982 | 'true' |
| 983 | 983 | ), |
@@ -1051,7 +1051,7 @@ discard block |
||
| 1051 | 1051 | 'Incoming $map_values array should have a count of four values in it. This is what was given: %s', |
| 1052 | 1052 | 'event_espresso' |
| 1053 | 1053 | ), |
| 1054 | - '<br>' . print_r($map_values, true) |
|
| 1054 | + '<br>'.print_r($map_values, true) |
|
| 1055 | 1055 | ) |
| 1056 | 1056 | ); |
| 1057 | 1057 | } |
@@ -1091,7 +1091,7 @@ discard block |
||
| 1091 | 1091 | // error proof if the name has EEM in it |
| 1092 | 1092 | $this->_model_name = str_replace('EEM', '', $this->_model_name); |
| 1093 | 1093 | $this->_model = EE_Registry::instance()->load_model($this->_model_name); |
| 1094 | - if (! $this->_model instanceof EEM_Base) { |
|
| 1094 | + if ( ! $this->_model instanceof EEM_Base) { |
|
| 1095 | 1095 | throw new EE_Error( |
| 1096 | 1096 | sprintf( |
| 1097 | 1097 | __( |
@@ -1177,7 +1177,7 @@ discard block |
||
| 1177 | 1177 | |
| 1178 | 1178 | // okay it is a meta cap so let's first remove that cap from the $caps array. |
| 1179 | 1179 | if (($key = array_search($cap, $caps)) !== false) { |
| 1180 | - unset($caps[ $key ]); |
|
| 1180 | + unset($caps[$key]); |
|
| 1181 | 1181 | } |
| 1182 | 1182 | |
| 1183 | 1183 | // cast $user_id to int for later explicit comparisons |
@@ -1186,11 +1186,11 @@ discard block |
||
| 1186 | 1186 | /** @var EE_Base_Class $obj */ |
| 1187 | 1187 | $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
| 1188 | 1188 | // if no obj then let's just do cap |
| 1189 | - if (! $obj instanceof EE_Base_Class) { |
|
| 1189 | + if ( ! $obj instanceof EE_Base_Class) { |
|
| 1190 | 1190 | $caps[] = 'do_not_allow'; |
| 1191 | 1191 | return $caps; |
| 1192 | 1192 | } |
| 1193 | - $caps[] = $cap . 's'; |
|
| 1193 | + $caps[] = $cap.'s'; |
|
| 1194 | 1194 | if ($obj instanceof EE_CPT_Base) { |
| 1195 | 1195 | // if the item author is set and the user is the author... |
| 1196 | 1196 | if ($obj->wp_user() && $user_id === $obj->wp_user()) { |
@@ -1200,12 +1200,12 @@ discard block |
||
| 1200 | 1200 | } |
| 1201 | 1201 | } else { |
| 1202 | 1202 | // the user is trying to edit someone else's obj |
| 1203 | - if (! empty($this->others_cap)) { |
|
| 1203 | + if ( ! empty($this->others_cap)) { |
|
| 1204 | 1204 | $caps[] = $this->others_cap; |
| 1205 | 1205 | } |
| 1206 | - if (! empty($this->published_cap) && $obj->status() === 'publish') { |
|
| 1206 | + if ( ! empty($this->published_cap) && $obj->status() === 'publish') { |
|
| 1207 | 1207 | $caps[] = $this->published_cap; |
| 1208 | - } elseif (! empty($this->private_cap) && $obj->status() === 'private') { |
|
| 1208 | + } elseif ( ! empty($this->private_cap) && $obj->status() === 'private') { |
|
| 1209 | 1209 | $caps[] = $this->private_cap; |
| 1210 | 1210 | } |
| 1211 | 1211 | } |
@@ -1221,8 +1221,8 @@ discard block |
||
| 1221 | 1221 | EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
| 1222 | 1222 | } |
| 1223 | 1223 | } |
| 1224 | - if (! $has_cap) { |
|
| 1225 | - if (! empty($this->others_cap)) { |
|
| 1224 | + if ( ! $has_cap) { |
|
| 1225 | + if ( ! empty($this->others_cap)) { |
|
| 1226 | 1226 | $caps[] = $this->others_cap; |
| 1227 | 1227 | } |
| 1228 | 1228 | } |
@@ -1301,7 +1301,7 @@ discard block |
||
| 1301 | 1301 | |
| 1302 | 1302 | // okay it is a meta cap so let's first remove that cap from the $caps array. |
| 1303 | 1303 | if (($key = array_search($cap, $caps)) !== false) { |
| 1304 | - unset($caps[ $key ]); |
|
| 1304 | + unset($caps[$key]); |
|
| 1305 | 1305 | } |
| 1306 | 1306 | |
| 1307 | 1307 | // cast $user_id to int for later explicit comparisons |
@@ -1309,12 +1309,12 @@ discard block |
||
| 1309 | 1309 | |
| 1310 | 1310 | $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
| 1311 | 1311 | // if no obj then let's just do cap |
| 1312 | - if (! $obj instanceof EE_Base_Class) { |
|
| 1312 | + if ( ! $obj instanceof EE_Base_Class) { |
|
| 1313 | 1313 | $caps[] = 'do_not_allow'; |
| 1314 | 1314 | return $caps; |
| 1315 | 1315 | } |
| 1316 | 1316 | |
| 1317 | - $caps[] = $cap . 's'; |
|
| 1317 | + $caps[] = $cap.'s'; |
|
| 1318 | 1318 | if ($obj instanceof EE_CPT_Base) { |
| 1319 | 1319 | $status_obj = get_post_status_object($obj->status()); |
| 1320 | 1320 | if ($status_obj->public) { |
@@ -1322,7 +1322,7 @@ discard block |
||
| 1322 | 1322 | } |
| 1323 | 1323 | // if the item author is set and the user is not the author... |
| 1324 | 1324 | if ($obj->wp_user() && $obj->wp_user() !== $user_id) { |
| 1325 | - if (! empty($this->others_cap)) { |
|
| 1325 | + if ( ! empty($this->others_cap)) { |
|
| 1326 | 1326 | $caps[] = $this->others_cap; |
| 1327 | 1327 | } |
| 1328 | 1328 | } |
@@ -1346,11 +1346,11 @@ discard block |
||
| 1346 | 1346 | EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
| 1347 | 1347 | } |
| 1348 | 1348 | } |
| 1349 | - if (! $has_cap) { |
|
| 1350 | - if (! empty($this->private_cap)) { |
|
| 1349 | + if ( ! $has_cap) { |
|
| 1350 | + if ( ! empty($this->private_cap)) { |
|
| 1351 | 1351 | $caps[] = $this->private_cap; |
| 1352 | 1352 | } |
| 1353 | - if (! empty($this->others_cap)) { |
|
| 1353 | + if ( ! empty($this->others_cap)) { |
|
| 1354 | 1354 | $caps[] = $this->others_cap; |
| 1355 | 1355 | } |
| 1356 | 1356 | } |
@@ -1396,7 +1396,7 @@ discard block |
||
| 1396 | 1396 | |
| 1397 | 1397 | // okay it is a meta cap so let's first remove that cap from the $caps array. |
| 1398 | 1398 | if (($key = array_search($cap, $caps)) !== false) { |
| 1399 | - unset($caps[ $key ]); |
|
| 1399 | + unset($caps[$key]); |
|
| 1400 | 1400 | } |
| 1401 | 1401 | |
| 1402 | 1402 | // cast $user_id to int for later explicit comparisons |
@@ -1404,11 +1404,11 @@ discard block |
||
| 1404 | 1404 | |
| 1405 | 1405 | $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
| 1406 | 1406 | // if no obj then let's just do cap |
| 1407 | - if (! $obj instanceof EE_Message_Template_Group) { |
|
| 1407 | + if ( ! $obj instanceof EE_Message_Template_Group) { |
|
| 1408 | 1408 | $caps[] = 'do_not_allow'; |
| 1409 | 1409 | return $caps; |
| 1410 | 1410 | } |
| 1411 | - $caps[] = $cap . 's'; |
|
| 1411 | + $caps[] = $cap.'s'; |
|
| 1412 | 1412 | $is_global = $obj->is_global(); |
| 1413 | 1413 | if ($obj->wp_user() && $obj->wp_user() === $user_id) { |
| 1414 | 1414 | if ($is_global) { |
@@ -1459,15 +1459,15 @@ discard block |
||
| 1459 | 1459 | } |
| 1460 | 1460 | // okay it is a meta cap so let's first remove that cap from the $caps array. |
| 1461 | 1461 | if (($key = array_search($cap, $caps)) !== false) { |
| 1462 | - unset($caps[ $key ]); |
|
| 1462 | + unset($caps[$key]); |
|
| 1463 | 1463 | } |
| 1464 | 1464 | $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
| 1465 | 1465 | // if no obj then let's just do cap |
| 1466 | - if (! $obj instanceof EE_Base_Class) { |
|
| 1466 | + if ( ! $obj instanceof EE_Base_Class) { |
|
| 1467 | 1467 | $caps[] = 'do_not_allow'; |
| 1468 | 1468 | return $caps; |
| 1469 | 1469 | } |
| 1470 | - $caps[] = $cap . 's'; |
|
| 1470 | + $caps[] = $cap.'s'; |
|
| 1471 | 1471 | $is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false; |
| 1472 | 1472 | $is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system; |
| 1473 | 1473 | if ($is_system) { |
@@ -14,981 +14,981 @@ discard block |
||
| 14 | 14 | final class EE_Capabilities extends EE_Base |
| 15 | 15 | { |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * the name of the wp option used to store caps previously initialized |
|
| 19 | - */ |
|
| 20 | - const option_name = 'ee_caps_initialized'; |
|
| 21 | - |
|
| 22 | - /** |
|
| 23 | - * instance of EE_Capabilities object |
|
| 24 | - * |
|
| 25 | - * @var EE_Capabilities |
|
| 26 | - */ |
|
| 27 | - private static $_instance; |
|
| 28 | - |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * This is a map of caps that correspond to a default WP_Role. |
|
| 32 | - * Array is indexed by Role and values are ee capabilities. |
|
| 33 | - * |
|
| 34 | - * @since 4.5.0 |
|
| 35 | - * |
|
| 36 | - * @var array |
|
| 37 | - */ |
|
| 38 | - private $capabilities_map = array(); |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * This used to hold an array of EE_Meta_Capability_Map objects |
|
| 42 | - * that define the granular capabilities mapped to for a user depending on context. |
|
| 43 | - * |
|
| 44 | - * @var EE_Meta_Capability_Map[] |
|
| 45 | - */ |
|
| 46 | - private $_meta_caps = array(); |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * The internal $capabilities_map needs to be initialized before it can be used. |
|
| 50 | - * This flag tracks whether that has happened or not. |
|
| 51 | - * But for this to work, we need three states to indicate: |
|
| 52 | - * initialization has not occurred at all |
|
| 53 | - * initialization has started but is not complete |
|
| 54 | - * initialization is complete |
|
| 55 | - * The reason this is needed is because the addCaps() method |
|
| 56 | - * normally requires the $capabilities_map to be initialized, |
|
| 57 | - * but is also used during the initialization process. |
|
| 58 | - * So: |
|
| 59 | - * If initialized === null, init_caps() will be called before any other methods will run. |
|
| 60 | - * If initialized === false, then init_caps() is in the process of running it's logic. |
|
| 61 | - * If initialized === true, then init_caps() has completed the initialization process. |
|
| 62 | - * |
|
| 63 | - * @var boolean|null $initialized |
|
| 64 | - */ |
|
| 65 | - private $initialized; |
|
| 66 | - |
|
| 67 | - /** |
|
| 68 | - * @var boolean $reset |
|
| 69 | - */ |
|
| 70 | - private $reset = false; |
|
| 71 | - |
|
| 72 | - |
|
| 73 | - /** |
|
| 74 | - * singleton method used to instantiate class object |
|
| 75 | - * |
|
| 76 | - * @since 4.5.0 |
|
| 77 | - * |
|
| 78 | - * @return EE_Capabilities |
|
| 79 | - */ |
|
| 80 | - public static function instance() |
|
| 81 | - { |
|
| 82 | - // check if instantiated, and if not do so. |
|
| 83 | - if (! self::$_instance instanceof EE_Capabilities) { |
|
| 84 | - self::$_instance = new self(); |
|
| 85 | - } |
|
| 86 | - return self::$_instance; |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * private constructor |
|
| 92 | - * |
|
| 93 | - * @since 4.5.0 |
|
| 94 | - */ |
|
| 95 | - private function __construct() |
|
| 96 | - { |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - |
|
| 100 | - /** |
|
| 101 | - * This delays the initialization of the capabilities class until EE_System core is loaded and ready. |
|
| 102 | - * |
|
| 103 | - * @param bool $reset allows for resetting the default capabilities saved on roles. Note that this doesn't |
|
| 104 | - * actually REMOVE any capabilities from existing roles, it just resaves defaults roles and |
|
| 105 | - * ensures that they are up to date. |
|
| 106 | - * |
|
| 107 | - * @since 4.5.0 |
|
| 108 | - * @return bool |
|
| 109 | - * @throws EE_Error |
|
| 110 | - */ |
|
| 111 | - public function init_caps($reset = false) |
|
| 112 | - { |
|
| 113 | - if (! EE_Maintenance_Mode::instance()->models_can_query()) { |
|
| 114 | - return false; |
|
| 115 | - } |
|
| 116 | - $this->reset = filter_var($reset, FILTER_VALIDATE_BOOLEAN); |
|
| 117 | - // if reset, then completely delete the cache option and clear the $capabilities_map property. |
|
| 118 | - if ($this->reset) { |
|
| 119 | - $this->initialized = null; |
|
| 120 | - $this->capabilities_map = array(); |
|
| 121 | - delete_option(self::option_name); |
|
| 122 | - } |
|
| 123 | - if ($this->initialized === null) { |
|
| 124 | - $this->initialized = false; |
|
| 125 | - do_action( |
|
| 126 | - 'AHEE__EE_Capabilities__init_caps__before_initialization', |
|
| 127 | - $this->reset |
|
| 128 | - ); |
|
| 129 | - $this->addCaps($this->_init_caps_map()); |
|
| 130 | - $this->_set_meta_caps(); |
|
| 131 | - do_action( |
|
| 132 | - 'AHEE__EE_Capabilities__init_caps__after_initialization', |
|
| 133 | - $this->capabilities_map |
|
| 134 | - ); |
|
| 135 | - $this->initialized = true; |
|
| 136 | - } |
|
| 137 | - // reset $this->reset so that it's not stuck on true if init_caps() gets called again |
|
| 138 | - $this->reset = false; |
|
| 139 | - return true; |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - |
|
| 143 | - /** |
|
| 144 | - * This sets the meta caps property. |
|
| 145 | - * |
|
| 146 | - * @since 4.5.0 |
|
| 147 | - * @return void |
|
| 148 | - * @throws EE_Error |
|
| 149 | - */ |
|
| 150 | - private function _set_meta_caps() |
|
| 151 | - { |
|
| 152 | - // get default meta caps and filter the returned array |
|
| 153 | - $this->_meta_caps = apply_filters( |
|
| 154 | - 'FHEE__EE_Capabilities___set_meta_caps__meta_caps', |
|
| 155 | - $this->_get_default_meta_caps_array() |
|
| 156 | - ); |
|
| 157 | - // add filter for map_meta_caps but only if models can query. |
|
| 158 | - if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) { |
|
| 159 | - add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4); |
|
| 160 | - } |
|
| 161 | - } |
|
| 162 | - |
|
| 163 | - |
|
| 164 | - /** |
|
| 165 | - * This builds and returns the default meta_caps array only once. |
|
| 166 | - * |
|
| 167 | - * @since 4.8.28.rc.012 |
|
| 168 | - * @return array |
|
| 169 | - * @throws EE_Error |
|
| 170 | - */ |
|
| 171 | - private function _get_default_meta_caps_array() |
|
| 172 | - { |
|
| 173 | - static $default_meta_caps = array(); |
|
| 174 | - // make sure we're only ever initializing the default _meta_caps array once if it's empty. |
|
| 175 | - if (empty($default_meta_caps)) { |
|
| 176 | - $default_meta_caps = array( |
|
| 177 | - // edits |
|
| 178 | - new EE_Meta_Capability_Map_Edit( |
|
| 179 | - 'ee_edit_event', |
|
| 180 | - array('Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events') |
|
| 181 | - ), |
|
| 182 | - new EE_Meta_Capability_Map_Edit( |
|
| 183 | - 'ee_edit_venue', |
|
| 184 | - array('Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues') |
|
| 185 | - ), |
|
| 186 | - new EE_Meta_Capability_Map_Edit( |
|
| 187 | - 'ee_edit_registration', |
|
| 188 | - array('Registration', '', 'ee_edit_others_registrations', '') |
|
| 189 | - ), |
|
| 190 | - new EE_Meta_Capability_Map_Edit( |
|
| 191 | - 'ee_edit_checkin', |
|
| 192 | - array('Registration', '', 'ee_edit_others_checkins', '') |
|
| 193 | - ), |
|
| 194 | - new EE_Meta_Capability_Map_Messages_Cap( |
|
| 195 | - 'ee_edit_message', |
|
| 196 | - array('Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages') |
|
| 197 | - ), |
|
| 198 | - new EE_Meta_Capability_Map_Edit( |
|
| 199 | - 'ee_edit_default_ticket', |
|
| 200 | - array('Ticket', '', 'ee_edit_others_default_tickets', '') |
|
| 201 | - ), |
|
| 202 | - new EE_Meta_Capability_Map_Registration_Form_Cap( |
|
| 203 | - 'ee_edit_question', |
|
| 204 | - array('Question', '', '', 'ee_edit_system_questions') |
|
| 205 | - ), |
|
| 206 | - new EE_Meta_Capability_Map_Registration_Form_Cap( |
|
| 207 | - 'ee_edit_question_group', |
|
| 208 | - array('Question_Group', '', '', 'ee_edit_system_question_groups') |
|
| 209 | - ), |
|
| 210 | - new EE_Meta_Capability_Map_Edit( |
|
| 211 | - 'ee_edit_payment_method', |
|
| 212 | - array('Payment_Method', '', 'ee_edit_others_payment_methods', '') |
|
| 213 | - ), |
|
| 214 | - // reads |
|
| 215 | - new EE_Meta_Capability_Map_Read( |
|
| 216 | - 'ee_read_event', |
|
| 217 | - array('Event', '', 'ee_read_others_events', 'ee_read_private_events') |
|
| 218 | - ), |
|
| 219 | - new EE_Meta_Capability_Map_Read( |
|
| 220 | - 'ee_read_venue', |
|
| 221 | - array('Venue', '', 'ee_read_others_venues', 'ee_read_private_venues') |
|
| 222 | - ), |
|
| 223 | - new EE_Meta_Capability_Map_Read( |
|
| 224 | - 'ee_read_registration', |
|
| 225 | - array('Registration', '', 'ee_read_others_registrations', '') |
|
| 226 | - ), |
|
| 227 | - new EE_Meta_Capability_Map_Read( |
|
| 228 | - 'ee_read_checkin', |
|
| 229 | - array('Registration', '', 'ee_read_others_checkins', '') |
|
| 230 | - ), |
|
| 231 | - new EE_Meta_Capability_Map_Messages_Cap( |
|
| 232 | - 'ee_read_message', |
|
| 233 | - array('Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages') |
|
| 234 | - ), |
|
| 235 | - new EE_Meta_Capability_Map_Read( |
|
| 236 | - 'ee_read_default_ticket', |
|
| 237 | - array('Ticket', '', 'ee_read_others_default_tickets', '') |
|
| 238 | - ), |
|
| 239 | - new EE_Meta_Capability_Map_Read( |
|
| 240 | - 'ee_read_payment_method', |
|
| 241 | - array('Payment_Method', '', 'ee_read_others_payment_methods', '') |
|
| 242 | - ), |
|
| 243 | - // deletes |
|
| 244 | - new EE_Meta_Capability_Map_Delete( |
|
| 245 | - 'ee_delete_event', |
|
| 246 | - array( |
|
| 247 | - 'Event', |
|
| 248 | - 'ee_delete_published_events', |
|
| 249 | - 'ee_delete_others_events', |
|
| 250 | - 'ee_delete_private_events', |
|
| 251 | - ) |
|
| 252 | - ), |
|
| 253 | - new EE_Meta_Capability_Map_Delete( |
|
| 254 | - 'ee_delete_venue', |
|
| 255 | - array( |
|
| 256 | - 'Venue', |
|
| 257 | - 'ee_delete_published_venues', |
|
| 258 | - 'ee_delete_others_venues', |
|
| 259 | - 'ee_delete_private_venues', |
|
| 260 | - ) |
|
| 261 | - ), |
|
| 262 | - new EE_Meta_Capability_Map_Delete( |
|
| 263 | - 'ee_delete_registration', |
|
| 264 | - array('Registration', '', 'ee_delete_others_registrations', '') |
|
| 265 | - ), |
|
| 266 | - new EE_Meta_Capability_Map_Delete( |
|
| 267 | - 'ee_delete_checkin', |
|
| 268 | - array('Registration', '', 'ee_delete_others_checkins', '') |
|
| 269 | - ), |
|
| 270 | - new EE_Meta_Capability_Map_Messages_Cap( |
|
| 271 | - 'ee_delete_message', |
|
| 272 | - array('Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages') |
|
| 273 | - ), |
|
| 274 | - new EE_Meta_Capability_Map_Delete( |
|
| 275 | - 'ee_delete_default_ticket', |
|
| 276 | - array('Ticket', '', 'ee_delete_others_default_tickets', '') |
|
| 277 | - ), |
|
| 278 | - new EE_Meta_Capability_Map_Registration_Form_Cap( |
|
| 279 | - 'ee_delete_question', |
|
| 280 | - array('Question', '', '', 'delete_system_questions') |
|
| 281 | - ), |
|
| 282 | - new EE_Meta_Capability_Map_Registration_Form_Cap( |
|
| 283 | - 'ee_delete_question_group', |
|
| 284 | - array('Question_Group', '', '', 'delete_system_question_groups') |
|
| 285 | - ), |
|
| 286 | - new EE_Meta_Capability_Map_Delete( |
|
| 287 | - 'ee_delete_payment_method', |
|
| 288 | - array('Payment_Method', '', 'ee_delete_others_payment_methods', '') |
|
| 289 | - ), |
|
| 290 | - ); |
|
| 291 | - } |
|
| 292 | - return $default_meta_caps; |
|
| 293 | - } |
|
| 294 | - |
|
| 295 | - |
|
| 296 | - /** |
|
| 297 | - * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
| 298 | - * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
| 299 | - * |
|
| 300 | - * The actual logic is carried out by implementer classes in their definition of _map_meta_caps. |
|
| 301 | - * |
|
| 302 | - * @since 4.5.0 |
|
| 303 | - * @see wp-includes/capabilities.php |
|
| 304 | - * |
|
| 305 | - * @param array $caps actual users capabilities |
|
| 306 | - * @param string $cap initial capability name that is being checked (the "map" key) |
|
| 307 | - * @param int $user_id The user id |
|
| 308 | - * @param array $args Adds context to the cap. Typically the object ID. |
|
| 309 | - * @return array actual users capabilities |
|
| 310 | - * @throws EE_Error |
|
| 311 | - */ |
|
| 312 | - public function map_meta_caps($caps, $cap, $user_id, $args) |
|
| 313 | - { |
|
| 314 | - if (did_action('AHEE__EE_System__load_espresso_addons__complete')) { |
|
| 315 | - // loop through our _meta_caps array |
|
| 316 | - foreach ($this->_meta_caps as $meta_map) { |
|
| 317 | - if (! $meta_map instanceof EE_Meta_Capability_Map) { |
|
| 318 | - continue; |
|
| 319 | - } |
|
| 320 | - // don't load models if there is no object ID in the args |
|
| 321 | - if (! empty($args[0])) { |
|
| 322 | - $meta_map->ensure_is_model(); |
|
| 323 | - } |
|
| 324 | - $caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args); |
|
| 325 | - } |
|
| 326 | - } |
|
| 327 | - return $caps; |
|
| 328 | - } |
|
| 329 | - |
|
| 330 | - |
|
| 331 | - /** |
|
| 332 | - * This sets up and returns the initial capabilities map for Event Espresso |
|
| 333 | - * Note this array is filtered. |
|
| 334 | - * It is assumed that all available EE capabilities are assigned to the administrator role. |
|
| 335 | - * |
|
| 336 | - * @since 4.5.0 |
|
| 337 | - * |
|
| 338 | - * @return array |
|
| 339 | - */ |
|
| 340 | - private function _init_caps_map() |
|
| 341 | - { |
|
| 342 | - return apply_filters( |
|
| 343 | - 'FHEE__EE_Capabilities__init_caps_map__caps', |
|
| 344 | - array( |
|
| 345 | - 'administrator' => array( |
|
| 346 | - // basic access |
|
| 347 | - 'ee_read_ee', |
|
| 348 | - // gateways |
|
| 349 | - /** |
|
| 350 | - * note that with payment method capabilities, although we've implemented |
|
| 351 | - * capability mapping which will be used for accessing payment methods owned by |
|
| 352 | - * other users. This is not fully implemented yet in the payment method ui. |
|
| 353 | - * Currently only the "plural" caps are in active use. |
|
| 354 | - * (Specific payment method caps are in use as well). |
|
| 355 | - **/ |
|
| 356 | - 'ee_manage_gateways', |
|
| 357 | - 'ee_read_payment_methods', |
|
| 358 | - 'ee_read_others_payment_methods', |
|
| 359 | - 'ee_edit_payment_methods', |
|
| 360 | - 'ee_edit_others_payment_methods', |
|
| 361 | - 'ee_delete_payment_methods', |
|
| 362 | - // events |
|
| 363 | - 'ee_publish_events', |
|
| 364 | - 'ee_read_private_events', |
|
| 365 | - 'ee_read_others_events', |
|
| 366 | - 'ee_read_events', |
|
| 367 | - 'ee_edit_events', |
|
| 368 | - 'ee_edit_published_events', |
|
| 369 | - 'ee_edit_others_events', |
|
| 370 | - 'ee_edit_private_events', |
|
| 371 | - 'ee_delete_published_events', |
|
| 372 | - 'ee_delete_private_events', |
|
| 373 | - 'ee_delete_events', |
|
| 374 | - 'ee_delete_others_events', |
|
| 375 | - // event categories |
|
| 376 | - 'ee_manage_event_categories', |
|
| 377 | - 'ee_edit_event_category', |
|
| 378 | - 'ee_delete_event_category', |
|
| 379 | - 'ee_assign_event_category', |
|
| 380 | - // venues |
|
| 381 | - 'ee_publish_venues', |
|
| 382 | - 'ee_read_venues', |
|
| 383 | - 'ee_read_others_venues', |
|
| 384 | - 'ee_read_private_venues', |
|
| 385 | - 'ee_edit_venues', |
|
| 386 | - 'ee_edit_others_venues', |
|
| 387 | - 'ee_edit_published_venues', |
|
| 388 | - 'ee_edit_private_venues', |
|
| 389 | - 'ee_delete_venues', |
|
| 390 | - 'ee_delete_others_venues', |
|
| 391 | - 'ee_delete_private_venues', |
|
| 392 | - 'ee_delete_published_venues', |
|
| 393 | - // venue categories |
|
| 394 | - 'ee_manage_venue_categories', |
|
| 395 | - 'ee_edit_venue_category', |
|
| 396 | - 'ee_delete_venue_category', |
|
| 397 | - 'ee_assign_venue_category', |
|
| 398 | - // contacts |
|
| 399 | - 'ee_read_contacts', |
|
| 400 | - 'ee_edit_contacts', |
|
| 401 | - 'ee_delete_contacts', |
|
| 402 | - // registrations |
|
| 403 | - 'ee_read_registrations', |
|
| 404 | - 'ee_read_others_registrations', |
|
| 405 | - 'ee_edit_registrations', |
|
| 406 | - 'ee_edit_others_registrations', |
|
| 407 | - 'ee_delete_registrations', |
|
| 408 | - 'ee_delete_others_registrations', |
|
| 409 | - // checkins |
|
| 410 | - 'ee_read_others_checkins', |
|
| 411 | - 'ee_read_checkins', |
|
| 412 | - 'ee_edit_checkins', |
|
| 413 | - 'ee_edit_others_checkins', |
|
| 414 | - 'ee_delete_checkins', |
|
| 415 | - 'ee_delete_others_checkins', |
|
| 416 | - // transactions && payments |
|
| 417 | - 'ee_read_transaction', |
|
| 418 | - 'ee_read_transactions', |
|
| 419 | - 'ee_edit_payments', |
|
| 420 | - 'ee_delete_payments', |
|
| 421 | - // messages |
|
| 422 | - 'ee_read_messages', |
|
| 423 | - 'ee_read_others_messages', |
|
| 424 | - 'ee_read_global_messages', |
|
| 425 | - 'ee_edit_global_messages', |
|
| 426 | - 'ee_edit_messages', |
|
| 427 | - 'ee_edit_others_messages', |
|
| 428 | - 'ee_delete_messages', |
|
| 429 | - 'ee_delete_others_messages', |
|
| 430 | - 'ee_delete_global_messages', |
|
| 431 | - 'ee_send_message', |
|
| 432 | - // tickets |
|
| 433 | - 'ee_read_default_tickets', |
|
| 434 | - 'ee_read_others_default_tickets', |
|
| 435 | - 'ee_edit_default_tickets', |
|
| 436 | - 'ee_edit_others_default_tickets', |
|
| 437 | - 'ee_delete_default_tickets', |
|
| 438 | - 'ee_delete_others_default_tickets', |
|
| 439 | - // prices |
|
| 440 | - 'ee_edit_default_price', |
|
| 441 | - 'ee_edit_default_prices', |
|
| 442 | - 'ee_delete_default_price', |
|
| 443 | - 'ee_delete_default_prices', |
|
| 444 | - 'ee_edit_default_price_type', |
|
| 445 | - 'ee_edit_default_price_types', |
|
| 446 | - 'ee_delete_default_price_type', |
|
| 447 | - 'ee_delete_default_price_types', |
|
| 448 | - 'ee_read_default_prices', |
|
| 449 | - 'ee_read_default_price_types', |
|
| 450 | - // registration form |
|
| 451 | - 'ee_edit_questions', |
|
| 452 | - 'ee_edit_system_questions', |
|
| 453 | - 'ee_read_questions', |
|
| 454 | - 'ee_delete_questions', |
|
| 455 | - 'ee_edit_question_groups', |
|
| 456 | - 'ee_read_question_groups', |
|
| 457 | - 'ee_edit_system_question_groups', |
|
| 458 | - 'ee_delete_question_groups', |
|
| 459 | - // event_type taxonomy |
|
| 460 | - 'ee_assign_event_type', |
|
| 461 | - 'ee_manage_event_types', |
|
| 462 | - 'ee_edit_event_type', |
|
| 463 | - 'ee_delete_event_type', |
|
| 464 | - ), |
|
| 465 | - 'ee_events_administrator' => array( |
|
| 466 | - // core wp caps |
|
| 467 | - 'read', |
|
| 468 | - 'read_private_pages', |
|
| 469 | - 'read_private_posts', |
|
| 470 | - 'edit_users', |
|
| 471 | - 'edit_posts', |
|
| 472 | - 'edit_pages', |
|
| 473 | - 'edit_published_posts', |
|
| 474 | - 'edit_published_pages', |
|
| 475 | - 'edit_private_pages', |
|
| 476 | - 'edit_private_posts', |
|
| 477 | - 'edit_others_posts', |
|
| 478 | - 'edit_others_pages', |
|
| 479 | - 'publish_posts', |
|
| 480 | - 'publish_pages', |
|
| 481 | - 'delete_posts', |
|
| 482 | - 'delete_pages', |
|
| 483 | - 'delete_private_pages', |
|
| 484 | - 'delete_private_posts', |
|
| 485 | - 'delete_published_pages', |
|
| 486 | - 'delete_published_posts', |
|
| 487 | - 'delete_others_posts', |
|
| 488 | - 'delete_others_pages', |
|
| 489 | - 'manage_categories', |
|
| 490 | - 'manage_links', |
|
| 491 | - 'moderate_comments', |
|
| 492 | - 'unfiltered_html', |
|
| 493 | - 'upload_files', |
|
| 494 | - 'export', |
|
| 495 | - 'import', |
|
| 496 | - 'list_users', |
|
| 497 | - 'level_1', // required if user with this role shows up in author dropdowns |
|
| 498 | - // basic ee access |
|
| 499 | - 'ee_read_ee', |
|
| 500 | - // events |
|
| 501 | - 'ee_publish_events', |
|
| 502 | - 'ee_read_private_events', |
|
| 503 | - 'ee_read_others_events', |
|
| 504 | - 'ee_read_event', |
|
| 505 | - 'ee_read_events', |
|
| 506 | - 'ee_edit_event', |
|
| 507 | - 'ee_edit_events', |
|
| 508 | - 'ee_edit_published_events', |
|
| 509 | - 'ee_edit_others_events', |
|
| 510 | - 'ee_edit_private_events', |
|
| 511 | - 'ee_delete_published_events', |
|
| 512 | - 'ee_delete_private_events', |
|
| 513 | - 'ee_delete_event', |
|
| 514 | - 'ee_delete_events', |
|
| 515 | - 'ee_delete_others_events', |
|
| 516 | - // event categories |
|
| 517 | - 'ee_manage_event_categories', |
|
| 518 | - 'ee_edit_event_category', |
|
| 519 | - 'ee_delete_event_category', |
|
| 520 | - 'ee_assign_event_category', |
|
| 521 | - // venues |
|
| 522 | - 'ee_publish_venues', |
|
| 523 | - 'ee_read_venue', |
|
| 524 | - 'ee_read_venues', |
|
| 525 | - 'ee_read_others_venues', |
|
| 526 | - 'ee_read_private_venues', |
|
| 527 | - 'ee_edit_venue', |
|
| 528 | - 'ee_edit_venues', |
|
| 529 | - 'ee_edit_others_venues', |
|
| 530 | - 'ee_edit_published_venues', |
|
| 531 | - 'ee_edit_private_venues', |
|
| 532 | - 'ee_delete_venue', |
|
| 533 | - 'ee_delete_venues', |
|
| 534 | - 'ee_delete_others_venues', |
|
| 535 | - 'ee_delete_private_venues', |
|
| 536 | - 'ee_delete_published_venues', |
|
| 537 | - // venue categories |
|
| 538 | - 'ee_manage_venue_categories', |
|
| 539 | - 'ee_edit_venue_category', |
|
| 540 | - 'ee_delete_venue_category', |
|
| 541 | - 'ee_assign_venue_category', |
|
| 542 | - // contacts |
|
| 543 | - 'ee_read_contacts', |
|
| 544 | - 'ee_edit_contacts', |
|
| 545 | - 'ee_delete_contacts', |
|
| 546 | - // registrations |
|
| 547 | - 'ee_read_registrations', |
|
| 548 | - 'ee_read_others_registrations', |
|
| 549 | - 'ee_edit_registration', |
|
| 550 | - 'ee_edit_registrations', |
|
| 551 | - 'ee_edit_others_registrations', |
|
| 552 | - 'ee_delete_registration', |
|
| 553 | - 'ee_delete_registrations', |
|
| 554 | - 'ee_delete_others_registrations', |
|
| 555 | - // checkins |
|
| 556 | - 'ee_read_others_checkins', |
|
| 557 | - 'ee_read_checkins', |
|
| 558 | - 'ee_edit_checkins', |
|
| 559 | - 'ee_edit_others_checkins', |
|
| 560 | - 'ee_delete_checkins', |
|
| 561 | - 'ee_delete_others_checkins', |
|
| 562 | - // transactions && payments |
|
| 563 | - 'ee_read_transaction', |
|
| 564 | - 'ee_read_transactions', |
|
| 565 | - 'ee_edit_payments', |
|
| 566 | - 'ee_delete_payments', |
|
| 567 | - // messages |
|
| 568 | - 'ee_read_messages', |
|
| 569 | - 'ee_read_others_messages', |
|
| 570 | - 'ee_read_global_messages', |
|
| 571 | - 'ee_edit_global_messages', |
|
| 572 | - 'ee_edit_messages', |
|
| 573 | - 'ee_edit_others_messages', |
|
| 574 | - 'ee_delete_messages', |
|
| 575 | - 'ee_delete_others_messages', |
|
| 576 | - 'ee_delete_global_messages', |
|
| 577 | - 'ee_send_message', |
|
| 578 | - // tickets |
|
| 579 | - 'ee_read_default_tickets', |
|
| 580 | - 'ee_read_others_default_tickets', |
|
| 581 | - 'ee_edit_default_tickets', |
|
| 582 | - 'ee_edit_others_default_tickets', |
|
| 583 | - 'ee_delete_default_tickets', |
|
| 584 | - 'ee_delete_others_default_tickets', |
|
| 585 | - // prices |
|
| 586 | - 'ee_edit_default_price', |
|
| 587 | - 'ee_edit_default_prices', |
|
| 588 | - 'ee_delete_default_price', |
|
| 589 | - 'ee_delete_default_prices', |
|
| 590 | - 'ee_edit_default_price_type', |
|
| 591 | - 'ee_edit_default_price_types', |
|
| 592 | - 'ee_delete_default_price_type', |
|
| 593 | - 'ee_delete_default_price_types', |
|
| 594 | - 'ee_read_default_prices', |
|
| 595 | - 'ee_read_default_price_types', |
|
| 596 | - // registration form |
|
| 597 | - 'ee_edit_questions', |
|
| 598 | - 'ee_edit_system_questions', |
|
| 599 | - 'ee_read_questions', |
|
| 600 | - 'ee_delete_questions', |
|
| 601 | - 'ee_edit_question_groups', |
|
| 602 | - 'ee_read_question_groups', |
|
| 603 | - 'ee_edit_system_question_groups', |
|
| 604 | - 'ee_delete_question_groups', |
|
| 605 | - // event_type taxonomy |
|
| 606 | - 'ee_assign_event_type', |
|
| 607 | - 'ee_manage_event_types', |
|
| 608 | - 'ee_edit_event_type', |
|
| 609 | - 'ee_delete_event_type', |
|
| 610 | - ), |
|
| 611 | - ) |
|
| 612 | - ); |
|
| 613 | - } |
|
| 614 | - |
|
| 615 | - |
|
| 616 | - /** |
|
| 617 | - * @return bool |
|
| 618 | - * @throws EE_Error |
|
| 619 | - */ |
|
| 620 | - private function setupCapabilitiesMap() |
|
| 621 | - { |
|
| 622 | - // if the initialization process hasn't even started, then we need to call init_caps() |
|
| 623 | - if ($this->initialized === null) { |
|
| 624 | - return $this->init_caps(); |
|
| 625 | - } |
|
| 626 | - // unless resetting, get caps from db if we haven't already |
|
| 627 | - $this->capabilities_map = $this->reset || ! empty($this->capabilities_map) |
|
| 628 | - ? $this->capabilities_map |
|
| 629 | - : get_option(self::option_name, array()); |
|
| 630 | - return true; |
|
| 631 | - } |
|
| 632 | - |
|
| 633 | - |
|
| 634 | - /** |
|
| 635 | - * @param bool $update |
|
| 636 | - * @return bool |
|
| 637 | - */ |
|
| 638 | - private function updateCapabilitiesMap($update = true) |
|
| 639 | - { |
|
| 640 | - return $update ? update_option(self::option_name, $this->capabilities_map) : false; |
|
| 641 | - } |
|
| 642 | - |
|
| 643 | - |
|
| 644 | - /** |
|
| 645 | - * Adds capabilities to roles. |
|
| 646 | - * |
|
| 647 | - * @since 4.9.42 |
|
| 648 | - * @param array $capabilities_to_add array of capabilities to add, indexed by roles. |
|
| 649 | - * Note that this should ONLY be called on activation hook |
|
| 650 | - * otherwise the caps will be added on every request. |
|
| 651 | - * @return bool |
|
| 652 | - * @throws \EE_Error |
|
| 653 | - */ |
|
| 654 | - public function addCaps(array $capabilities_to_add) |
|
| 655 | - { |
|
| 656 | - // don't do anything if the capabilities map can not be initialized |
|
| 657 | - if (! $this->setupCapabilitiesMap()) { |
|
| 658 | - return false; |
|
| 659 | - } |
|
| 660 | - // and filter the array so others can get in on the fun during resets |
|
| 661 | - $capabilities_to_add = apply_filters( |
|
| 662 | - 'FHEE__EE_Capabilities__addCaps__capabilities_to_add', |
|
| 663 | - $capabilities_to_add, |
|
| 664 | - $this->reset, |
|
| 665 | - $this->capabilities_map |
|
| 666 | - ); |
|
| 667 | - $update_capabilities_map = false; |
|
| 668 | - // if not reset, see what caps are new for each role. if they're new, add them. |
|
| 669 | - foreach ($capabilities_to_add as $role => $caps_for_role) { |
|
| 670 | - if (is_array($caps_for_role)) { |
|
| 671 | - foreach ($caps_for_role as $cap) { |
|
| 672 | - if (! $this->capHasBeenAddedToRole($role, $cap) |
|
| 673 | - && $this->add_cap_to_role($role, $cap, true, false) |
|
| 674 | - ) { |
|
| 675 | - $update_capabilities_map = true; |
|
| 676 | - } |
|
| 677 | - } |
|
| 678 | - } |
|
| 679 | - } |
|
| 680 | - // now let's just save the cap that has been set but only if there's been a change. |
|
| 681 | - $updated = $this->updateCapabilitiesMap($update_capabilities_map); |
|
| 682 | - $this->flushWpUser($updated); |
|
| 683 | - do_action('AHEE__EE_Capabilities__addCaps__complete', $this->capabilities_map, $updated); |
|
| 684 | - return $updated; |
|
| 685 | - } |
|
| 686 | - |
|
| 687 | - |
|
| 688 | - /** |
|
| 689 | - * Loops through the capabilities map and removes the role caps specified by the incoming array |
|
| 690 | - * |
|
| 691 | - * @param array $caps_map map of capabilities to be removed (indexed by roles) |
|
| 692 | - * @return bool |
|
| 693 | - * @throws \EE_Error |
|
| 694 | - */ |
|
| 695 | - public function removeCaps($caps_map) |
|
| 696 | - { |
|
| 697 | - // don't do anything if the capabilities map can not be initialized |
|
| 698 | - if (! $this->setupCapabilitiesMap()) { |
|
| 699 | - return false; |
|
| 700 | - } |
|
| 701 | - $update_capabilities_map = false; |
|
| 702 | - foreach ($caps_map as $role => $caps_for_role) { |
|
| 703 | - if (is_array($caps_for_role)) { |
|
| 704 | - foreach ($caps_for_role as $cap) { |
|
| 705 | - if ($this->capHasBeenAddedToRole($role, $cap) |
|
| 706 | - && $this->remove_cap_from_role($role, $cap, false) |
|
| 707 | - ) { |
|
| 708 | - $update_capabilities_map = true; |
|
| 709 | - } |
|
| 710 | - } |
|
| 711 | - } |
|
| 712 | - } |
|
| 713 | - // maybe resave the caps |
|
| 714 | - $updated = $this->updateCapabilitiesMap($update_capabilities_map); |
|
| 715 | - $this->flushWpUser($updated); |
|
| 716 | - return $updated; |
|
| 717 | - } |
|
| 718 | - |
|
| 719 | - |
|
| 720 | - /** |
|
| 721 | - * This ensures that the WP User object cached on the $current_user global in WP has the latest capabilities from |
|
| 722 | - * the roles on that user. |
|
| 723 | - * |
|
| 724 | - * @param bool $flush Default is to flush the WP_User object. If false, then this method effectively does nothing. |
|
| 725 | - */ |
|
| 726 | - private function flushWpUser($flush = true) |
|
| 727 | - { |
|
| 728 | - if ($flush) { |
|
| 729 | - $user = wp_get_current_user(); |
|
| 730 | - if ($user instanceof WP_User) { |
|
| 731 | - $user->get_role_caps(); |
|
| 732 | - } |
|
| 733 | - } |
|
| 734 | - } |
|
| 735 | - |
|
| 736 | - |
|
| 737 | - /** |
|
| 738 | - * This method sets a capability on a role. Note this should only be done on activation, or if you have something |
|
| 739 | - * specific to prevent the cap from being added on every page load (adding caps are persistent to the db). Note. |
|
| 740 | - * this is a wrapper for $wp_role->add_cap() |
|
| 741 | - * |
|
| 742 | - * @see wp-includes/capabilities.php |
|
| 743 | - * @since 4.5.0 |
|
| 744 | - * @param string|WP_Role $role A WordPress role the capability is being added to |
|
| 745 | - * @param string $cap The capability being added to the role |
|
| 746 | - * @param bool $grant Whether to grant access to this cap on this role. |
|
| 747 | - * @param bool $update_capabilities_map |
|
| 748 | - * @return bool |
|
| 749 | - * @throws \EE_Error |
|
| 750 | - */ |
|
| 751 | - public function add_cap_to_role($role, $cap, $grant = true, $update_capabilities_map = true) |
|
| 752 | - { |
|
| 753 | - // capture incoming value for $role because we may need it to create a new WP_Role |
|
| 754 | - $orig_role = $role; |
|
| 755 | - $role = $role instanceof WP_Role ? $role : get_role($role); |
|
| 756 | - // if the role isn't available then we create it. |
|
| 757 | - if (! $role instanceof WP_Role) { |
|
| 758 | - // if a plugin wants to create a specific role name then they should create the role before |
|
| 759 | - // EE_Capabilities does. Otherwise this function will create the role name from the slug: |
|
| 760 | - // - removes any `ee_` namespacing from the start of the slug. |
|
| 761 | - // - replaces `_` with ` ` (empty space). |
|
| 762 | - // - sentence case on the resulting string. |
|
| 763 | - $role_label = ucwords(str_replace(array('ee_', '_'), array('', ' '), $orig_role)); |
|
| 764 | - $role = add_role($orig_role, $role_label); |
|
| 765 | - } |
|
| 766 | - if ($role instanceof WP_Role) { |
|
| 767 | - // don't do anything if the capabilities map can not be initialized |
|
| 768 | - if (! $this->setupCapabilitiesMap()) { |
|
| 769 | - return false; |
|
| 770 | - } |
|
| 771 | - if (! $this->capHasBeenAddedToRole($role->name, $cap)) { |
|
| 772 | - $role->add_cap($cap, $grant); |
|
| 773 | - $this->capabilities_map[ $role->name ][] = $cap; |
|
| 774 | - $this->updateCapabilitiesMap($update_capabilities_map); |
|
| 775 | - return true; |
|
| 776 | - } |
|
| 777 | - } |
|
| 778 | - return false; |
|
| 779 | - } |
|
| 780 | - |
|
| 781 | - |
|
| 782 | - /** |
|
| 783 | - * Functions similarly to add_cap_to_role except removes cap from given role. |
|
| 784 | - * Wrapper for $wp_role->remove_cap() |
|
| 785 | - * |
|
| 786 | - * @see wp-includes/capabilities.php |
|
| 787 | - * @since 4.5.0 |
|
| 788 | - * @param string|WP_Role $role A WordPress role the capability is being removed from. |
|
| 789 | - * @param string $cap The capability being removed |
|
| 790 | - * @param bool $update_capabilities_map |
|
| 791 | - * @return bool |
|
| 792 | - * @throws \EE_Error |
|
| 793 | - */ |
|
| 794 | - public function remove_cap_from_role($role, $cap, $update_capabilities_map = true) |
|
| 795 | - { |
|
| 796 | - // don't do anything if the capabilities map can not be initialized |
|
| 797 | - if (! $this->setupCapabilitiesMap()) { |
|
| 798 | - return false; |
|
| 799 | - } |
|
| 800 | - |
|
| 801 | - $role = $role instanceof WP_Role ? $role : get_role($role); |
|
| 802 | - if ($role instanceof WP_Role && $index = $this->capHasBeenAddedToRole($role->name, $cap, true)) { |
|
| 803 | - $role->remove_cap($cap); |
|
| 804 | - unset($this->capabilities_map[ $role->name ][ $index ]); |
|
| 805 | - $this->updateCapabilitiesMap($update_capabilities_map); |
|
| 806 | - return true; |
|
| 807 | - } |
|
| 808 | - return false; |
|
| 809 | - } |
|
| 810 | - |
|
| 811 | - |
|
| 812 | - /** |
|
| 813 | - * @param string $role_name |
|
| 814 | - * @param string $cap |
|
| 815 | - * @param bool $get_index |
|
| 816 | - * @return bool|mixed |
|
| 817 | - */ |
|
| 818 | - private function capHasBeenAddedToRole($role_name = '', $cap = '', $get_index = false) |
|
| 819 | - { |
|
| 820 | - if (isset($this->capabilities_map[ $role_name ]) |
|
| 821 | - && ($index = array_search($cap, $this->capabilities_map[ $role_name ], true)) !== false |
|
| 822 | - ) { |
|
| 823 | - return $get_index ? $index : true; |
|
| 824 | - } |
|
| 825 | - return false; |
|
| 826 | - } |
|
| 827 | - |
|
| 828 | - |
|
| 829 | - /** |
|
| 830 | - * Wrapper for the native WP current_user_can() method. |
|
| 831 | - * This is provided as a handy method for a couple things: |
|
| 832 | - * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to |
|
| 833 | - * write those filters wherever current_user_can is called). |
|
| 834 | - * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters ) |
|
| 835 | - * |
|
| 836 | - * @since 4.5.0 |
|
| 837 | - * |
|
| 838 | - * @param string $cap The cap being checked. |
|
| 839 | - * @param string $context The context where the current_user_can is being called from. |
|
| 840 | - * @param int $id Optional. Id for item where current_user_can is being called from (used in map_meta_cap() |
|
| 841 | - * filters. |
|
| 842 | - * |
|
| 843 | - * @return bool Whether user can or not. |
|
| 844 | - */ |
|
| 845 | - public function current_user_can($cap, $context, $id = 0) |
|
| 846 | - { |
|
| 847 | - // apply filters (both a global on just the cap, and context specific. Global overrides context specific) |
|
| 848 | - $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id); |
|
| 849 | - $filtered_cap = apply_filters( |
|
| 850 | - 'FHEE__EE_Capabilities__current_user_can__cap', |
|
| 851 | - $filtered_cap, |
|
| 852 | - $context, |
|
| 853 | - $cap, |
|
| 854 | - $id |
|
| 855 | - ); |
|
| 856 | - return ! empty($id) |
|
| 857 | - ? current_user_can($filtered_cap, $id) |
|
| 858 | - : current_user_can($filtered_cap); |
|
| 859 | - } |
|
| 860 | - |
|
| 861 | - |
|
| 862 | - /** |
|
| 863 | - * This is a wrapper for the WP user_can() function and follows the same style as the other wrappers in this class. |
|
| 864 | - * |
|
| 865 | - * @param int|WP_User $user Either the user_id or a WP_User object |
|
| 866 | - * @param string $cap The capability string being checked |
|
| 867 | - * @param string $context The context where the user_can is being called from (used in filters). |
|
| 868 | - * @param int $id Optional. Id for item where user_can is being called from ( used in map_meta_cap() |
|
| 869 | - * filters) |
|
| 870 | - * |
|
| 871 | - * @return bool Whether user can or not. |
|
| 872 | - */ |
|
| 873 | - public function user_can($user, $cap, $context, $id = 0) |
|
| 874 | - { |
|
| 875 | - // apply filters (both a global on just the cap, and context specific. Global overrides context specific) |
|
| 876 | - $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id); |
|
| 877 | - $filtered_cap = apply_filters( |
|
| 878 | - 'FHEE__EE_Capabilities__user_can__cap', |
|
| 879 | - $filtered_cap, |
|
| 880 | - $context, |
|
| 881 | - $cap, |
|
| 882 | - $user, |
|
| 883 | - $id |
|
| 884 | - ); |
|
| 885 | - return ! empty($id) |
|
| 886 | - ? user_can($user, $filtered_cap, $id) |
|
| 887 | - : user_can($user, $filtered_cap); |
|
| 888 | - } |
|
| 889 | - |
|
| 890 | - |
|
| 891 | - /** |
|
| 892 | - * Wrapper for the native WP current_user_can_for_blog() method. |
|
| 893 | - * This is provided as a handy method for a couple things: |
|
| 894 | - * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to |
|
| 895 | - * write those filters wherever current_user_can is called). |
|
| 896 | - * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters ) |
|
| 897 | - * |
|
| 898 | - * @since 4.5.0 |
|
| 899 | - * |
|
| 900 | - * @param int $blog_id The blog id that is being checked for. |
|
| 901 | - * @param string $cap The cap being checked. |
|
| 902 | - * @param string $context The context where the current_user_can is being called from. |
|
| 903 | - * @param int $id Optional. Id for item where current_user_can is being called from (used in map_meta_cap() |
|
| 904 | - * filters. |
|
| 905 | - * |
|
| 906 | - * @return bool Whether user can or not. |
|
| 907 | - */ |
|
| 908 | - public function current_user_can_for_blog($blog_id, $cap, $context, $id = 0) |
|
| 909 | - { |
|
| 910 | - $user_can = ! empty($id) |
|
| 911 | - ? current_user_can_for_blog($blog_id, $cap, $id) |
|
| 912 | - : current_user_can($blog_id, $cap); |
|
| 913 | - // apply filters (both a global on just the cap, and context specific. Global overrides context specific) |
|
| 914 | - $user_can = apply_filters( |
|
| 915 | - 'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context, |
|
| 916 | - $user_can, |
|
| 917 | - $blog_id, |
|
| 918 | - $cap, |
|
| 919 | - $id |
|
| 920 | - ); |
|
| 921 | - $user_can = apply_filters( |
|
| 922 | - 'FHEE__EE_Capabilities__current_user_can_for_blog__user_can', |
|
| 923 | - $user_can, |
|
| 924 | - $context, |
|
| 925 | - $blog_id, |
|
| 926 | - $cap, |
|
| 927 | - $id |
|
| 928 | - ); |
|
| 929 | - return $user_can; |
|
| 930 | - } |
|
| 931 | - |
|
| 932 | - |
|
| 933 | - /** |
|
| 934 | - * This helper method just returns an array of registered EE capabilities. |
|
| 935 | - * |
|
| 936 | - * @since 4.5.0 |
|
| 937 | - * @param string $role If empty then the entire role/capability map is returned. |
|
| 938 | - * Otherwise just the capabilities for the given role are returned. |
|
| 939 | - * @return array |
|
| 940 | - * @throws EE_Error |
|
| 941 | - */ |
|
| 942 | - public function get_ee_capabilities($role = 'administrator') |
|
| 943 | - { |
|
| 944 | - if (! $this->initialized) { |
|
| 945 | - $this->init_caps(); |
|
| 946 | - } |
|
| 947 | - if (empty($role)) { |
|
| 948 | - return $this->capabilities_map; |
|
| 949 | - } |
|
| 950 | - return isset($this->capabilities_map[ $role ]) |
|
| 951 | - ? $this->capabilities_map[ $role ] |
|
| 952 | - : array(); |
|
| 953 | - } |
|
| 954 | - |
|
| 955 | - |
|
| 956 | - /** |
|
| 957 | - * @deprecated 4.9.42 |
|
| 958 | - * @param bool $reset If you need to reset Event Espresso's capabilities, |
|
| 959 | - * then please use the init_caps() method with the "$reset" parameter set to "true" |
|
| 960 | - * @param array $caps_map Optional. |
|
| 961 | - * Can be used to send a custom map of roles and capabilities for setting them up. |
|
| 962 | - * Note that this should ONLY be called on activation hook or some other one-time |
|
| 963 | - * task otherwise the caps will be added on every request. |
|
| 964 | - * @return void |
|
| 965 | - * @throws EE_Error |
|
| 966 | - */ |
|
| 967 | - public function init_role_caps($reset = false, $caps_map = array()) |
|
| 968 | - { |
|
| 969 | - // If this method is called directly and reset is set as 'true', |
|
| 970 | - // then display a doing it wrong notice, because we want resets to go through init_caps() |
|
| 971 | - // to guarantee that everything is set up correctly. |
|
| 972 | - // This prevents the capabilities map getting reset incorrectly by direct calls to this method. |
|
| 973 | - if ($reset) { |
|
| 974 | - EE_Error::doing_it_wrong( |
|
| 975 | - __METHOD__, |
|
| 976 | - sprintf( |
|
| 977 | - esc_html__( |
|
| 978 | - 'The "%1$s" parameter for the "%2$s" method is deprecated. If you need to reset Event Espresso\'s capabilities, then please use the "%3$s" method with the "%1$s" parameter set to "%4$s".', |
|
| 979 | - 'event_espresso' |
|
| 980 | - ), |
|
| 981 | - '$reset', |
|
| 982 | - __METHOD__ . '()', |
|
| 983 | - 'EE_Capabilities::init_caps()', |
|
| 984 | - 'true' |
|
| 985 | - ), |
|
| 986 | - '4.9.42', |
|
| 987 | - '5.0.0' |
|
| 988 | - ); |
|
| 989 | - } |
|
| 990 | - $this->addCaps($caps_map); |
|
| 991 | - } |
|
| 17 | + /** |
|
| 18 | + * the name of the wp option used to store caps previously initialized |
|
| 19 | + */ |
|
| 20 | + const option_name = 'ee_caps_initialized'; |
|
| 21 | + |
|
| 22 | + /** |
|
| 23 | + * instance of EE_Capabilities object |
|
| 24 | + * |
|
| 25 | + * @var EE_Capabilities |
|
| 26 | + */ |
|
| 27 | + private static $_instance; |
|
| 28 | + |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * This is a map of caps that correspond to a default WP_Role. |
|
| 32 | + * Array is indexed by Role and values are ee capabilities. |
|
| 33 | + * |
|
| 34 | + * @since 4.5.0 |
|
| 35 | + * |
|
| 36 | + * @var array |
|
| 37 | + */ |
|
| 38 | + private $capabilities_map = array(); |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * This used to hold an array of EE_Meta_Capability_Map objects |
|
| 42 | + * that define the granular capabilities mapped to for a user depending on context. |
|
| 43 | + * |
|
| 44 | + * @var EE_Meta_Capability_Map[] |
|
| 45 | + */ |
|
| 46 | + private $_meta_caps = array(); |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * The internal $capabilities_map needs to be initialized before it can be used. |
|
| 50 | + * This flag tracks whether that has happened or not. |
|
| 51 | + * But for this to work, we need three states to indicate: |
|
| 52 | + * initialization has not occurred at all |
|
| 53 | + * initialization has started but is not complete |
|
| 54 | + * initialization is complete |
|
| 55 | + * The reason this is needed is because the addCaps() method |
|
| 56 | + * normally requires the $capabilities_map to be initialized, |
|
| 57 | + * but is also used during the initialization process. |
|
| 58 | + * So: |
|
| 59 | + * If initialized === null, init_caps() will be called before any other methods will run. |
|
| 60 | + * If initialized === false, then init_caps() is in the process of running it's logic. |
|
| 61 | + * If initialized === true, then init_caps() has completed the initialization process. |
|
| 62 | + * |
|
| 63 | + * @var boolean|null $initialized |
|
| 64 | + */ |
|
| 65 | + private $initialized; |
|
| 66 | + |
|
| 67 | + /** |
|
| 68 | + * @var boolean $reset |
|
| 69 | + */ |
|
| 70 | + private $reset = false; |
|
| 71 | + |
|
| 72 | + |
|
| 73 | + /** |
|
| 74 | + * singleton method used to instantiate class object |
|
| 75 | + * |
|
| 76 | + * @since 4.5.0 |
|
| 77 | + * |
|
| 78 | + * @return EE_Capabilities |
|
| 79 | + */ |
|
| 80 | + public static function instance() |
|
| 81 | + { |
|
| 82 | + // check if instantiated, and if not do so. |
|
| 83 | + if (! self::$_instance instanceof EE_Capabilities) { |
|
| 84 | + self::$_instance = new self(); |
|
| 85 | + } |
|
| 86 | + return self::$_instance; |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * private constructor |
|
| 92 | + * |
|
| 93 | + * @since 4.5.0 |
|
| 94 | + */ |
|
| 95 | + private function __construct() |
|
| 96 | + { |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + |
|
| 100 | + /** |
|
| 101 | + * This delays the initialization of the capabilities class until EE_System core is loaded and ready. |
|
| 102 | + * |
|
| 103 | + * @param bool $reset allows for resetting the default capabilities saved on roles. Note that this doesn't |
|
| 104 | + * actually REMOVE any capabilities from existing roles, it just resaves defaults roles and |
|
| 105 | + * ensures that they are up to date. |
|
| 106 | + * |
|
| 107 | + * @since 4.5.0 |
|
| 108 | + * @return bool |
|
| 109 | + * @throws EE_Error |
|
| 110 | + */ |
|
| 111 | + public function init_caps($reset = false) |
|
| 112 | + { |
|
| 113 | + if (! EE_Maintenance_Mode::instance()->models_can_query()) { |
|
| 114 | + return false; |
|
| 115 | + } |
|
| 116 | + $this->reset = filter_var($reset, FILTER_VALIDATE_BOOLEAN); |
|
| 117 | + // if reset, then completely delete the cache option and clear the $capabilities_map property. |
|
| 118 | + if ($this->reset) { |
|
| 119 | + $this->initialized = null; |
|
| 120 | + $this->capabilities_map = array(); |
|
| 121 | + delete_option(self::option_name); |
|
| 122 | + } |
|
| 123 | + if ($this->initialized === null) { |
|
| 124 | + $this->initialized = false; |
|
| 125 | + do_action( |
|
| 126 | + 'AHEE__EE_Capabilities__init_caps__before_initialization', |
|
| 127 | + $this->reset |
|
| 128 | + ); |
|
| 129 | + $this->addCaps($this->_init_caps_map()); |
|
| 130 | + $this->_set_meta_caps(); |
|
| 131 | + do_action( |
|
| 132 | + 'AHEE__EE_Capabilities__init_caps__after_initialization', |
|
| 133 | + $this->capabilities_map |
|
| 134 | + ); |
|
| 135 | + $this->initialized = true; |
|
| 136 | + } |
|
| 137 | + // reset $this->reset so that it's not stuck on true if init_caps() gets called again |
|
| 138 | + $this->reset = false; |
|
| 139 | + return true; |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + |
|
| 143 | + /** |
|
| 144 | + * This sets the meta caps property. |
|
| 145 | + * |
|
| 146 | + * @since 4.5.0 |
|
| 147 | + * @return void |
|
| 148 | + * @throws EE_Error |
|
| 149 | + */ |
|
| 150 | + private function _set_meta_caps() |
|
| 151 | + { |
|
| 152 | + // get default meta caps and filter the returned array |
|
| 153 | + $this->_meta_caps = apply_filters( |
|
| 154 | + 'FHEE__EE_Capabilities___set_meta_caps__meta_caps', |
|
| 155 | + $this->_get_default_meta_caps_array() |
|
| 156 | + ); |
|
| 157 | + // add filter for map_meta_caps but only if models can query. |
|
| 158 | + if (! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) { |
|
| 159 | + add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4); |
|
| 160 | + } |
|
| 161 | + } |
|
| 162 | + |
|
| 163 | + |
|
| 164 | + /** |
|
| 165 | + * This builds and returns the default meta_caps array only once. |
|
| 166 | + * |
|
| 167 | + * @since 4.8.28.rc.012 |
|
| 168 | + * @return array |
|
| 169 | + * @throws EE_Error |
|
| 170 | + */ |
|
| 171 | + private function _get_default_meta_caps_array() |
|
| 172 | + { |
|
| 173 | + static $default_meta_caps = array(); |
|
| 174 | + // make sure we're only ever initializing the default _meta_caps array once if it's empty. |
|
| 175 | + if (empty($default_meta_caps)) { |
|
| 176 | + $default_meta_caps = array( |
|
| 177 | + // edits |
|
| 178 | + new EE_Meta_Capability_Map_Edit( |
|
| 179 | + 'ee_edit_event', |
|
| 180 | + array('Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events') |
|
| 181 | + ), |
|
| 182 | + new EE_Meta_Capability_Map_Edit( |
|
| 183 | + 'ee_edit_venue', |
|
| 184 | + array('Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues') |
|
| 185 | + ), |
|
| 186 | + new EE_Meta_Capability_Map_Edit( |
|
| 187 | + 'ee_edit_registration', |
|
| 188 | + array('Registration', '', 'ee_edit_others_registrations', '') |
|
| 189 | + ), |
|
| 190 | + new EE_Meta_Capability_Map_Edit( |
|
| 191 | + 'ee_edit_checkin', |
|
| 192 | + array('Registration', '', 'ee_edit_others_checkins', '') |
|
| 193 | + ), |
|
| 194 | + new EE_Meta_Capability_Map_Messages_Cap( |
|
| 195 | + 'ee_edit_message', |
|
| 196 | + array('Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages') |
|
| 197 | + ), |
|
| 198 | + new EE_Meta_Capability_Map_Edit( |
|
| 199 | + 'ee_edit_default_ticket', |
|
| 200 | + array('Ticket', '', 'ee_edit_others_default_tickets', '') |
|
| 201 | + ), |
|
| 202 | + new EE_Meta_Capability_Map_Registration_Form_Cap( |
|
| 203 | + 'ee_edit_question', |
|
| 204 | + array('Question', '', '', 'ee_edit_system_questions') |
|
| 205 | + ), |
|
| 206 | + new EE_Meta_Capability_Map_Registration_Form_Cap( |
|
| 207 | + 'ee_edit_question_group', |
|
| 208 | + array('Question_Group', '', '', 'ee_edit_system_question_groups') |
|
| 209 | + ), |
|
| 210 | + new EE_Meta_Capability_Map_Edit( |
|
| 211 | + 'ee_edit_payment_method', |
|
| 212 | + array('Payment_Method', '', 'ee_edit_others_payment_methods', '') |
|
| 213 | + ), |
|
| 214 | + // reads |
|
| 215 | + new EE_Meta_Capability_Map_Read( |
|
| 216 | + 'ee_read_event', |
|
| 217 | + array('Event', '', 'ee_read_others_events', 'ee_read_private_events') |
|
| 218 | + ), |
|
| 219 | + new EE_Meta_Capability_Map_Read( |
|
| 220 | + 'ee_read_venue', |
|
| 221 | + array('Venue', '', 'ee_read_others_venues', 'ee_read_private_venues') |
|
| 222 | + ), |
|
| 223 | + new EE_Meta_Capability_Map_Read( |
|
| 224 | + 'ee_read_registration', |
|
| 225 | + array('Registration', '', 'ee_read_others_registrations', '') |
|
| 226 | + ), |
|
| 227 | + new EE_Meta_Capability_Map_Read( |
|
| 228 | + 'ee_read_checkin', |
|
| 229 | + array('Registration', '', 'ee_read_others_checkins', '') |
|
| 230 | + ), |
|
| 231 | + new EE_Meta_Capability_Map_Messages_Cap( |
|
| 232 | + 'ee_read_message', |
|
| 233 | + array('Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages') |
|
| 234 | + ), |
|
| 235 | + new EE_Meta_Capability_Map_Read( |
|
| 236 | + 'ee_read_default_ticket', |
|
| 237 | + array('Ticket', '', 'ee_read_others_default_tickets', '') |
|
| 238 | + ), |
|
| 239 | + new EE_Meta_Capability_Map_Read( |
|
| 240 | + 'ee_read_payment_method', |
|
| 241 | + array('Payment_Method', '', 'ee_read_others_payment_methods', '') |
|
| 242 | + ), |
|
| 243 | + // deletes |
|
| 244 | + new EE_Meta_Capability_Map_Delete( |
|
| 245 | + 'ee_delete_event', |
|
| 246 | + array( |
|
| 247 | + 'Event', |
|
| 248 | + 'ee_delete_published_events', |
|
| 249 | + 'ee_delete_others_events', |
|
| 250 | + 'ee_delete_private_events', |
|
| 251 | + ) |
|
| 252 | + ), |
|
| 253 | + new EE_Meta_Capability_Map_Delete( |
|
| 254 | + 'ee_delete_venue', |
|
| 255 | + array( |
|
| 256 | + 'Venue', |
|
| 257 | + 'ee_delete_published_venues', |
|
| 258 | + 'ee_delete_others_venues', |
|
| 259 | + 'ee_delete_private_venues', |
|
| 260 | + ) |
|
| 261 | + ), |
|
| 262 | + new EE_Meta_Capability_Map_Delete( |
|
| 263 | + 'ee_delete_registration', |
|
| 264 | + array('Registration', '', 'ee_delete_others_registrations', '') |
|
| 265 | + ), |
|
| 266 | + new EE_Meta_Capability_Map_Delete( |
|
| 267 | + 'ee_delete_checkin', |
|
| 268 | + array('Registration', '', 'ee_delete_others_checkins', '') |
|
| 269 | + ), |
|
| 270 | + new EE_Meta_Capability_Map_Messages_Cap( |
|
| 271 | + 'ee_delete_message', |
|
| 272 | + array('Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages') |
|
| 273 | + ), |
|
| 274 | + new EE_Meta_Capability_Map_Delete( |
|
| 275 | + 'ee_delete_default_ticket', |
|
| 276 | + array('Ticket', '', 'ee_delete_others_default_tickets', '') |
|
| 277 | + ), |
|
| 278 | + new EE_Meta_Capability_Map_Registration_Form_Cap( |
|
| 279 | + 'ee_delete_question', |
|
| 280 | + array('Question', '', '', 'delete_system_questions') |
|
| 281 | + ), |
|
| 282 | + new EE_Meta_Capability_Map_Registration_Form_Cap( |
|
| 283 | + 'ee_delete_question_group', |
|
| 284 | + array('Question_Group', '', '', 'delete_system_question_groups') |
|
| 285 | + ), |
|
| 286 | + new EE_Meta_Capability_Map_Delete( |
|
| 287 | + 'ee_delete_payment_method', |
|
| 288 | + array('Payment_Method', '', 'ee_delete_others_payment_methods', '') |
|
| 289 | + ), |
|
| 290 | + ); |
|
| 291 | + } |
|
| 292 | + return $default_meta_caps; |
|
| 293 | + } |
|
| 294 | + |
|
| 295 | + |
|
| 296 | + /** |
|
| 297 | + * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
| 298 | + * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
| 299 | + * |
|
| 300 | + * The actual logic is carried out by implementer classes in their definition of _map_meta_caps. |
|
| 301 | + * |
|
| 302 | + * @since 4.5.0 |
|
| 303 | + * @see wp-includes/capabilities.php |
|
| 304 | + * |
|
| 305 | + * @param array $caps actual users capabilities |
|
| 306 | + * @param string $cap initial capability name that is being checked (the "map" key) |
|
| 307 | + * @param int $user_id The user id |
|
| 308 | + * @param array $args Adds context to the cap. Typically the object ID. |
|
| 309 | + * @return array actual users capabilities |
|
| 310 | + * @throws EE_Error |
|
| 311 | + */ |
|
| 312 | + public function map_meta_caps($caps, $cap, $user_id, $args) |
|
| 313 | + { |
|
| 314 | + if (did_action('AHEE__EE_System__load_espresso_addons__complete')) { |
|
| 315 | + // loop through our _meta_caps array |
|
| 316 | + foreach ($this->_meta_caps as $meta_map) { |
|
| 317 | + if (! $meta_map instanceof EE_Meta_Capability_Map) { |
|
| 318 | + continue; |
|
| 319 | + } |
|
| 320 | + // don't load models if there is no object ID in the args |
|
| 321 | + if (! empty($args[0])) { |
|
| 322 | + $meta_map->ensure_is_model(); |
|
| 323 | + } |
|
| 324 | + $caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args); |
|
| 325 | + } |
|
| 326 | + } |
|
| 327 | + return $caps; |
|
| 328 | + } |
|
| 329 | + |
|
| 330 | + |
|
| 331 | + /** |
|
| 332 | + * This sets up and returns the initial capabilities map for Event Espresso |
|
| 333 | + * Note this array is filtered. |
|
| 334 | + * It is assumed that all available EE capabilities are assigned to the administrator role. |
|
| 335 | + * |
|
| 336 | + * @since 4.5.0 |
|
| 337 | + * |
|
| 338 | + * @return array |
|
| 339 | + */ |
|
| 340 | + private function _init_caps_map() |
|
| 341 | + { |
|
| 342 | + return apply_filters( |
|
| 343 | + 'FHEE__EE_Capabilities__init_caps_map__caps', |
|
| 344 | + array( |
|
| 345 | + 'administrator' => array( |
|
| 346 | + // basic access |
|
| 347 | + 'ee_read_ee', |
|
| 348 | + // gateways |
|
| 349 | + /** |
|
| 350 | + * note that with payment method capabilities, although we've implemented |
|
| 351 | + * capability mapping which will be used for accessing payment methods owned by |
|
| 352 | + * other users. This is not fully implemented yet in the payment method ui. |
|
| 353 | + * Currently only the "plural" caps are in active use. |
|
| 354 | + * (Specific payment method caps are in use as well). |
|
| 355 | + **/ |
|
| 356 | + 'ee_manage_gateways', |
|
| 357 | + 'ee_read_payment_methods', |
|
| 358 | + 'ee_read_others_payment_methods', |
|
| 359 | + 'ee_edit_payment_methods', |
|
| 360 | + 'ee_edit_others_payment_methods', |
|
| 361 | + 'ee_delete_payment_methods', |
|
| 362 | + // events |
|
| 363 | + 'ee_publish_events', |
|
| 364 | + 'ee_read_private_events', |
|
| 365 | + 'ee_read_others_events', |
|
| 366 | + 'ee_read_events', |
|
| 367 | + 'ee_edit_events', |
|
| 368 | + 'ee_edit_published_events', |
|
| 369 | + 'ee_edit_others_events', |
|
| 370 | + 'ee_edit_private_events', |
|
| 371 | + 'ee_delete_published_events', |
|
| 372 | + 'ee_delete_private_events', |
|
| 373 | + 'ee_delete_events', |
|
| 374 | + 'ee_delete_others_events', |
|
| 375 | + // event categories |
|
| 376 | + 'ee_manage_event_categories', |
|
| 377 | + 'ee_edit_event_category', |
|
| 378 | + 'ee_delete_event_category', |
|
| 379 | + 'ee_assign_event_category', |
|
| 380 | + // venues |
|
| 381 | + 'ee_publish_venues', |
|
| 382 | + 'ee_read_venues', |
|
| 383 | + 'ee_read_others_venues', |
|
| 384 | + 'ee_read_private_venues', |
|
| 385 | + 'ee_edit_venues', |
|
| 386 | + 'ee_edit_others_venues', |
|
| 387 | + 'ee_edit_published_venues', |
|
| 388 | + 'ee_edit_private_venues', |
|
| 389 | + 'ee_delete_venues', |
|
| 390 | + 'ee_delete_others_venues', |
|
| 391 | + 'ee_delete_private_venues', |
|
| 392 | + 'ee_delete_published_venues', |
|
| 393 | + // venue categories |
|
| 394 | + 'ee_manage_venue_categories', |
|
| 395 | + 'ee_edit_venue_category', |
|
| 396 | + 'ee_delete_venue_category', |
|
| 397 | + 'ee_assign_venue_category', |
|
| 398 | + // contacts |
|
| 399 | + 'ee_read_contacts', |
|
| 400 | + 'ee_edit_contacts', |
|
| 401 | + 'ee_delete_contacts', |
|
| 402 | + // registrations |
|
| 403 | + 'ee_read_registrations', |
|
| 404 | + 'ee_read_others_registrations', |
|
| 405 | + 'ee_edit_registrations', |
|
| 406 | + 'ee_edit_others_registrations', |
|
| 407 | + 'ee_delete_registrations', |
|
| 408 | + 'ee_delete_others_registrations', |
|
| 409 | + // checkins |
|
| 410 | + 'ee_read_others_checkins', |
|
| 411 | + 'ee_read_checkins', |
|
| 412 | + 'ee_edit_checkins', |
|
| 413 | + 'ee_edit_others_checkins', |
|
| 414 | + 'ee_delete_checkins', |
|
| 415 | + 'ee_delete_others_checkins', |
|
| 416 | + // transactions && payments |
|
| 417 | + 'ee_read_transaction', |
|
| 418 | + 'ee_read_transactions', |
|
| 419 | + 'ee_edit_payments', |
|
| 420 | + 'ee_delete_payments', |
|
| 421 | + // messages |
|
| 422 | + 'ee_read_messages', |
|
| 423 | + 'ee_read_others_messages', |
|
| 424 | + 'ee_read_global_messages', |
|
| 425 | + 'ee_edit_global_messages', |
|
| 426 | + 'ee_edit_messages', |
|
| 427 | + 'ee_edit_others_messages', |
|
| 428 | + 'ee_delete_messages', |
|
| 429 | + 'ee_delete_others_messages', |
|
| 430 | + 'ee_delete_global_messages', |
|
| 431 | + 'ee_send_message', |
|
| 432 | + // tickets |
|
| 433 | + 'ee_read_default_tickets', |
|
| 434 | + 'ee_read_others_default_tickets', |
|
| 435 | + 'ee_edit_default_tickets', |
|
| 436 | + 'ee_edit_others_default_tickets', |
|
| 437 | + 'ee_delete_default_tickets', |
|
| 438 | + 'ee_delete_others_default_tickets', |
|
| 439 | + // prices |
|
| 440 | + 'ee_edit_default_price', |
|
| 441 | + 'ee_edit_default_prices', |
|
| 442 | + 'ee_delete_default_price', |
|
| 443 | + 'ee_delete_default_prices', |
|
| 444 | + 'ee_edit_default_price_type', |
|
| 445 | + 'ee_edit_default_price_types', |
|
| 446 | + 'ee_delete_default_price_type', |
|
| 447 | + 'ee_delete_default_price_types', |
|
| 448 | + 'ee_read_default_prices', |
|
| 449 | + 'ee_read_default_price_types', |
|
| 450 | + // registration form |
|
| 451 | + 'ee_edit_questions', |
|
| 452 | + 'ee_edit_system_questions', |
|
| 453 | + 'ee_read_questions', |
|
| 454 | + 'ee_delete_questions', |
|
| 455 | + 'ee_edit_question_groups', |
|
| 456 | + 'ee_read_question_groups', |
|
| 457 | + 'ee_edit_system_question_groups', |
|
| 458 | + 'ee_delete_question_groups', |
|
| 459 | + // event_type taxonomy |
|
| 460 | + 'ee_assign_event_type', |
|
| 461 | + 'ee_manage_event_types', |
|
| 462 | + 'ee_edit_event_type', |
|
| 463 | + 'ee_delete_event_type', |
|
| 464 | + ), |
|
| 465 | + 'ee_events_administrator' => array( |
|
| 466 | + // core wp caps |
|
| 467 | + 'read', |
|
| 468 | + 'read_private_pages', |
|
| 469 | + 'read_private_posts', |
|
| 470 | + 'edit_users', |
|
| 471 | + 'edit_posts', |
|
| 472 | + 'edit_pages', |
|
| 473 | + 'edit_published_posts', |
|
| 474 | + 'edit_published_pages', |
|
| 475 | + 'edit_private_pages', |
|
| 476 | + 'edit_private_posts', |
|
| 477 | + 'edit_others_posts', |
|
| 478 | + 'edit_others_pages', |
|
| 479 | + 'publish_posts', |
|
| 480 | + 'publish_pages', |
|
| 481 | + 'delete_posts', |
|
| 482 | + 'delete_pages', |
|
| 483 | + 'delete_private_pages', |
|
| 484 | + 'delete_private_posts', |
|
| 485 | + 'delete_published_pages', |
|
| 486 | + 'delete_published_posts', |
|
| 487 | + 'delete_others_posts', |
|
| 488 | + 'delete_others_pages', |
|
| 489 | + 'manage_categories', |
|
| 490 | + 'manage_links', |
|
| 491 | + 'moderate_comments', |
|
| 492 | + 'unfiltered_html', |
|
| 493 | + 'upload_files', |
|
| 494 | + 'export', |
|
| 495 | + 'import', |
|
| 496 | + 'list_users', |
|
| 497 | + 'level_1', // required if user with this role shows up in author dropdowns |
|
| 498 | + // basic ee access |
|
| 499 | + 'ee_read_ee', |
|
| 500 | + // events |
|
| 501 | + 'ee_publish_events', |
|
| 502 | + 'ee_read_private_events', |
|
| 503 | + 'ee_read_others_events', |
|
| 504 | + 'ee_read_event', |
|
| 505 | + 'ee_read_events', |
|
| 506 | + 'ee_edit_event', |
|
| 507 | + 'ee_edit_events', |
|
| 508 | + 'ee_edit_published_events', |
|
| 509 | + 'ee_edit_others_events', |
|
| 510 | + 'ee_edit_private_events', |
|
| 511 | + 'ee_delete_published_events', |
|
| 512 | + 'ee_delete_private_events', |
|
| 513 | + 'ee_delete_event', |
|
| 514 | + 'ee_delete_events', |
|
| 515 | + 'ee_delete_others_events', |
|
| 516 | + // event categories |
|
| 517 | + 'ee_manage_event_categories', |
|
| 518 | + 'ee_edit_event_category', |
|
| 519 | + 'ee_delete_event_category', |
|
| 520 | + 'ee_assign_event_category', |
|
| 521 | + // venues |
|
| 522 | + 'ee_publish_venues', |
|
| 523 | + 'ee_read_venue', |
|
| 524 | + 'ee_read_venues', |
|
| 525 | + 'ee_read_others_venues', |
|
| 526 | + 'ee_read_private_venues', |
|
| 527 | + 'ee_edit_venue', |
|
| 528 | + 'ee_edit_venues', |
|
| 529 | + 'ee_edit_others_venues', |
|
| 530 | + 'ee_edit_published_venues', |
|
| 531 | + 'ee_edit_private_venues', |
|
| 532 | + 'ee_delete_venue', |
|
| 533 | + 'ee_delete_venues', |
|
| 534 | + 'ee_delete_others_venues', |
|
| 535 | + 'ee_delete_private_venues', |
|
| 536 | + 'ee_delete_published_venues', |
|
| 537 | + // venue categories |
|
| 538 | + 'ee_manage_venue_categories', |
|
| 539 | + 'ee_edit_venue_category', |
|
| 540 | + 'ee_delete_venue_category', |
|
| 541 | + 'ee_assign_venue_category', |
|
| 542 | + // contacts |
|
| 543 | + 'ee_read_contacts', |
|
| 544 | + 'ee_edit_contacts', |
|
| 545 | + 'ee_delete_contacts', |
|
| 546 | + // registrations |
|
| 547 | + 'ee_read_registrations', |
|
| 548 | + 'ee_read_others_registrations', |
|
| 549 | + 'ee_edit_registration', |
|
| 550 | + 'ee_edit_registrations', |
|
| 551 | + 'ee_edit_others_registrations', |
|
| 552 | + 'ee_delete_registration', |
|
| 553 | + 'ee_delete_registrations', |
|
| 554 | + 'ee_delete_others_registrations', |
|
| 555 | + // checkins |
|
| 556 | + 'ee_read_others_checkins', |
|
| 557 | + 'ee_read_checkins', |
|
| 558 | + 'ee_edit_checkins', |
|
| 559 | + 'ee_edit_others_checkins', |
|
| 560 | + 'ee_delete_checkins', |
|
| 561 | + 'ee_delete_others_checkins', |
|
| 562 | + // transactions && payments |
|
| 563 | + 'ee_read_transaction', |
|
| 564 | + 'ee_read_transactions', |
|
| 565 | + 'ee_edit_payments', |
|
| 566 | + 'ee_delete_payments', |
|
| 567 | + // messages |
|
| 568 | + 'ee_read_messages', |
|
| 569 | + 'ee_read_others_messages', |
|
| 570 | + 'ee_read_global_messages', |
|
| 571 | + 'ee_edit_global_messages', |
|
| 572 | + 'ee_edit_messages', |
|
| 573 | + 'ee_edit_others_messages', |
|
| 574 | + 'ee_delete_messages', |
|
| 575 | + 'ee_delete_others_messages', |
|
| 576 | + 'ee_delete_global_messages', |
|
| 577 | + 'ee_send_message', |
|
| 578 | + // tickets |
|
| 579 | + 'ee_read_default_tickets', |
|
| 580 | + 'ee_read_others_default_tickets', |
|
| 581 | + 'ee_edit_default_tickets', |
|
| 582 | + 'ee_edit_others_default_tickets', |
|
| 583 | + 'ee_delete_default_tickets', |
|
| 584 | + 'ee_delete_others_default_tickets', |
|
| 585 | + // prices |
|
| 586 | + 'ee_edit_default_price', |
|
| 587 | + 'ee_edit_default_prices', |
|
| 588 | + 'ee_delete_default_price', |
|
| 589 | + 'ee_delete_default_prices', |
|
| 590 | + 'ee_edit_default_price_type', |
|
| 591 | + 'ee_edit_default_price_types', |
|
| 592 | + 'ee_delete_default_price_type', |
|
| 593 | + 'ee_delete_default_price_types', |
|
| 594 | + 'ee_read_default_prices', |
|
| 595 | + 'ee_read_default_price_types', |
|
| 596 | + // registration form |
|
| 597 | + 'ee_edit_questions', |
|
| 598 | + 'ee_edit_system_questions', |
|
| 599 | + 'ee_read_questions', |
|
| 600 | + 'ee_delete_questions', |
|
| 601 | + 'ee_edit_question_groups', |
|
| 602 | + 'ee_read_question_groups', |
|
| 603 | + 'ee_edit_system_question_groups', |
|
| 604 | + 'ee_delete_question_groups', |
|
| 605 | + // event_type taxonomy |
|
| 606 | + 'ee_assign_event_type', |
|
| 607 | + 'ee_manage_event_types', |
|
| 608 | + 'ee_edit_event_type', |
|
| 609 | + 'ee_delete_event_type', |
|
| 610 | + ), |
|
| 611 | + ) |
|
| 612 | + ); |
|
| 613 | + } |
|
| 614 | + |
|
| 615 | + |
|
| 616 | + /** |
|
| 617 | + * @return bool |
|
| 618 | + * @throws EE_Error |
|
| 619 | + */ |
|
| 620 | + private function setupCapabilitiesMap() |
|
| 621 | + { |
|
| 622 | + // if the initialization process hasn't even started, then we need to call init_caps() |
|
| 623 | + if ($this->initialized === null) { |
|
| 624 | + return $this->init_caps(); |
|
| 625 | + } |
|
| 626 | + // unless resetting, get caps from db if we haven't already |
|
| 627 | + $this->capabilities_map = $this->reset || ! empty($this->capabilities_map) |
|
| 628 | + ? $this->capabilities_map |
|
| 629 | + : get_option(self::option_name, array()); |
|
| 630 | + return true; |
|
| 631 | + } |
|
| 632 | + |
|
| 633 | + |
|
| 634 | + /** |
|
| 635 | + * @param bool $update |
|
| 636 | + * @return bool |
|
| 637 | + */ |
|
| 638 | + private function updateCapabilitiesMap($update = true) |
|
| 639 | + { |
|
| 640 | + return $update ? update_option(self::option_name, $this->capabilities_map) : false; |
|
| 641 | + } |
|
| 642 | + |
|
| 643 | + |
|
| 644 | + /** |
|
| 645 | + * Adds capabilities to roles. |
|
| 646 | + * |
|
| 647 | + * @since 4.9.42 |
|
| 648 | + * @param array $capabilities_to_add array of capabilities to add, indexed by roles. |
|
| 649 | + * Note that this should ONLY be called on activation hook |
|
| 650 | + * otherwise the caps will be added on every request. |
|
| 651 | + * @return bool |
|
| 652 | + * @throws \EE_Error |
|
| 653 | + */ |
|
| 654 | + public function addCaps(array $capabilities_to_add) |
|
| 655 | + { |
|
| 656 | + // don't do anything if the capabilities map can not be initialized |
|
| 657 | + if (! $this->setupCapabilitiesMap()) { |
|
| 658 | + return false; |
|
| 659 | + } |
|
| 660 | + // and filter the array so others can get in on the fun during resets |
|
| 661 | + $capabilities_to_add = apply_filters( |
|
| 662 | + 'FHEE__EE_Capabilities__addCaps__capabilities_to_add', |
|
| 663 | + $capabilities_to_add, |
|
| 664 | + $this->reset, |
|
| 665 | + $this->capabilities_map |
|
| 666 | + ); |
|
| 667 | + $update_capabilities_map = false; |
|
| 668 | + // if not reset, see what caps are new for each role. if they're new, add them. |
|
| 669 | + foreach ($capabilities_to_add as $role => $caps_for_role) { |
|
| 670 | + if (is_array($caps_for_role)) { |
|
| 671 | + foreach ($caps_for_role as $cap) { |
|
| 672 | + if (! $this->capHasBeenAddedToRole($role, $cap) |
|
| 673 | + && $this->add_cap_to_role($role, $cap, true, false) |
|
| 674 | + ) { |
|
| 675 | + $update_capabilities_map = true; |
|
| 676 | + } |
|
| 677 | + } |
|
| 678 | + } |
|
| 679 | + } |
|
| 680 | + // now let's just save the cap that has been set but only if there's been a change. |
|
| 681 | + $updated = $this->updateCapabilitiesMap($update_capabilities_map); |
|
| 682 | + $this->flushWpUser($updated); |
|
| 683 | + do_action('AHEE__EE_Capabilities__addCaps__complete', $this->capabilities_map, $updated); |
|
| 684 | + return $updated; |
|
| 685 | + } |
|
| 686 | + |
|
| 687 | + |
|
| 688 | + /** |
|
| 689 | + * Loops through the capabilities map and removes the role caps specified by the incoming array |
|
| 690 | + * |
|
| 691 | + * @param array $caps_map map of capabilities to be removed (indexed by roles) |
|
| 692 | + * @return bool |
|
| 693 | + * @throws \EE_Error |
|
| 694 | + */ |
|
| 695 | + public function removeCaps($caps_map) |
|
| 696 | + { |
|
| 697 | + // don't do anything if the capabilities map can not be initialized |
|
| 698 | + if (! $this->setupCapabilitiesMap()) { |
|
| 699 | + return false; |
|
| 700 | + } |
|
| 701 | + $update_capabilities_map = false; |
|
| 702 | + foreach ($caps_map as $role => $caps_for_role) { |
|
| 703 | + if (is_array($caps_for_role)) { |
|
| 704 | + foreach ($caps_for_role as $cap) { |
|
| 705 | + if ($this->capHasBeenAddedToRole($role, $cap) |
|
| 706 | + && $this->remove_cap_from_role($role, $cap, false) |
|
| 707 | + ) { |
|
| 708 | + $update_capabilities_map = true; |
|
| 709 | + } |
|
| 710 | + } |
|
| 711 | + } |
|
| 712 | + } |
|
| 713 | + // maybe resave the caps |
|
| 714 | + $updated = $this->updateCapabilitiesMap($update_capabilities_map); |
|
| 715 | + $this->flushWpUser($updated); |
|
| 716 | + return $updated; |
|
| 717 | + } |
|
| 718 | + |
|
| 719 | + |
|
| 720 | + /** |
|
| 721 | + * This ensures that the WP User object cached on the $current_user global in WP has the latest capabilities from |
|
| 722 | + * the roles on that user. |
|
| 723 | + * |
|
| 724 | + * @param bool $flush Default is to flush the WP_User object. If false, then this method effectively does nothing. |
|
| 725 | + */ |
|
| 726 | + private function flushWpUser($flush = true) |
|
| 727 | + { |
|
| 728 | + if ($flush) { |
|
| 729 | + $user = wp_get_current_user(); |
|
| 730 | + if ($user instanceof WP_User) { |
|
| 731 | + $user->get_role_caps(); |
|
| 732 | + } |
|
| 733 | + } |
|
| 734 | + } |
|
| 735 | + |
|
| 736 | + |
|
| 737 | + /** |
|
| 738 | + * This method sets a capability on a role. Note this should only be done on activation, or if you have something |
|
| 739 | + * specific to prevent the cap from being added on every page load (adding caps are persistent to the db). Note. |
|
| 740 | + * this is a wrapper for $wp_role->add_cap() |
|
| 741 | + * |
|
| 742 | + * @see wp-includes/capabilities.php |
|
| 743 | + * @since 4.5.0 |
|
| 744 | + * @param string|WP_Role $role A WordPress role the capability is being added to |
|
| 745 | + * @param string $cap The capability being added to the role |
|
| 746 | + * @param bool $grant Whether to grant access to this cap on this role. |
|
| 747 | + * @param bool $update_capabilities_map |
|
| 748 | + * @return bool |
|
| 749 | + * @throws \EE_Error |
|
| 750 | + */ |
|
| 751 | + public function add_cap_to_role($role, $cap, $grant = true, $update_capabilities_map = true) |
|
| 752 | + { |
|
| 753 | + // capture incoming value for $role because we may need it to create a new WP_Role |
|
| 754 | + $orig_role = $role; |
|
| 755 | + $role = $role instanceof WP_Role ? $role : get_role($role); |
|
| 756 | + // if the role isn't available then we create it. |
|
| 757 | + if (! $role instanceof WP_Role) { |
|
| 758 | + // if a plugin wants to create a specific role name then they should create the role before |
|
| 759 | + // EE_Capabilities does. Otherwise this function will create the role name from the slug: |
|
| 760 | + // - removes any `ee_` namespacing from the start of the slug. |
|
| 761 | + // - replaces `_` with ` ` (empty space). |
|
| 762 | + // - sentence case on the resulting string. |
|
| 763 | + $role_label = ucwords(str_replace(array('ee_', '_'), array('', ' '), $orig_role)); |
|
| 764 | + $role = add_role($orig_role, $role_label); |
|
| 765 | + } |
|
| 766 | + if ($role instanceof WP_Role) { |
|
| 767 | + // don't do anything if the capabilities map can not be initialized |
|
| 768 | + if (! $this->setupCapabilitiesMap()) { |
|
| 769 | + return false; |
|
| 770 | + } |
|
| 771 | + if (! $this->capHasBeenAddedToRole($role->name, $cap)) { |
|
| 772 | + $role->add_cap($cap, $grant); |
|
| 773 | + $this->capabilities_map[ $role->name ][] = $cap; |
|
| 774 | + $this->updateCapabilitiesMap($update_capabilities_map); |
|
| 775 | + return true; |
|
| 776 | + } |
|
| 777 | + } |
|
| 778 | + return false; |
|
| 779 | + } |
|
| 780 | + |
|
| 781 | + |
|
| 782 | + /** |
|
| 783 | + * Functions similarly to add_cap_to_role except removes cap from given role. |
|
| 784 | + * Wrapper for $wp_role->remove_cap() |
|
| 785 | + * |
|
| 786 | + * @see wp-includes/capabilities.php |
|
| 787 | + * @since 4.5.0 |
|
| 788 | + * @param string|WP_Role $role A WordPress role the capability is being removed from. |
|
| 789 | + * @param string $cap The capability being removed |
|
| 790 | + * @param bool $update_capabilities_map |
|
| 791 | + * @return bool |
|
| 792 | + * @throws \EE_Error |
|
| 793 | + */ |
|
| 794 | + public function remove_cap_from_role($role, $cap, $update_capabilities_map = true) |
|
| 795 | + { |
|
| 796 | + // don't do anything if the capabilities map can not be initialized |
|
| 797 | + if (! $this->setupCapabilitiesMap()) { |
|
| 798 | + return false; |
|
| 799 | + } |
|
| 800 | + |
|
| 801 | + $role = $role instanceof WP_Role ? $role : get_role($role); |
|
| 802 | + if ($role instanceof WP_Role && $index = $this->capHasBeenAddedToRole($role->name, $cap, true)) { |
|
| 803 | + $role->remove_cap($cap); |
|
| 804 | + unset($this->capabilities_map[ $role->name ][ $index ]); |
|
| 805 | + $this->updateCapabilitiesMap($update_capabilities_map); |
|
| 806 | + return true; |
|
| 807 | + } |
|
| 808 | + return false; |
|
| 809 | + } |
|
| 810 | + |
|
| 811 | + |
|
| 812 | + /** |
|
| 813 | + * @param string $role_name |
|
| 814 | + * @param string $cap |
|
| 815 | + * @param bool $get_index |
|
| 816 | + * @return bool|mixed |
|
| 817 | + */ |
|
| 818 | + private function capHasBeenAddedToRole($role_name = '', $cap = '', $get_index = false) |
|
| 819 | + { |
|
| 820 | + if (isset($this->capabilities_map[ $role_name ]) |
|
| 821 | + && ($index = array_search($cap, $this->capabilities_map[ $role_name ], true)) !== false |
|
| 822 | + ) { |
|
| 823 | + return $get_index ? $index : true; |
|
| 824 | + } |
|
| 825 | + return false; |
|
| 826 | + } |
|
| 827 | + |
|
| 828 | + |
|
| 829 | + /** |
|
| 830 | + * Wrapper for the native WP current_user_can() method. |
|
| 831 | + * This is provided as a handy method for a couple things: |
|
| 832 | + * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to |
|
| 833 | + * write those filters wherever current_user_can is called). |
|
| 834 | + * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters ) |
|
| 835 | + * |
|
| 836 | + * @since 4.5.0 |
|
| 837 | + * |
|
| 838 | + * @param string $cap The cap being checked. |
|
| 839 | + * @param string $context The context where the current_user_can is being called from. |
|
| 840 | + * @param int $id Optional. Id for item where current_user_can is being called from (used in map_meta_cap() |
|
| 841 | + * filters. |
|
| 842 | + * |
|
| 843 | + * @return bool Whether user can or not. |
|
| 844 | + */ |
|
| 845 | + public function current_user_can($cap, $context, $id = 0) |
|
| 846 | + { |
|
| 847 | + // apply filters (both a global on just the cap, and context specific. Global overrides context specific) |
|
| 848 | + $filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id); |
|
| 849 | + $filtered_cap = apply_filters( |
|
| 850 | + 'FHEE__EE_Capabilities__current_user_can__cap', |
|
| 851 | + $filtered_cap, |
|
| 852 | + $context, |
|
| 853 | + $cap, |
|
| 854 | + $id |
|
| 855 | + ); |
|
| 856 | + return ! empty($id) |
|
| 857 | + ? current_user_can($filtered_cap, $id) |
|
| 858 | + : current_user_can($filtered_cap); |
|
| 859 | + } |
|
| 860 | + |
|
| 861 | + |
|
| 862 | + /** |
|
| 863 | + * This is a wrapper for the WP user_can() function and follows the same style as the other wrappers in this class. |
|
| 864 | + * |
|
| 865 | + * @param int|WP_User $user Either the user_id or a WP_User object |
|
| 866 | + * @param string $cap The capability string being checked |
|
| 867 | + * @param string $context The context where the user_can is being called from (used in filters). |
|
| 868 | + * @param int $id Optional. Id for item where user_can is being called from ( used in map_meta_cap() |
|
| 869 | + * filters) |
|
| 870 | + * |
|
| 871 | + * @return bool Whether user can or not. |
|
| 872 | + */ |
|
| 873 | + public function user_can($user, $cap, $context, $id = 0) |
|
| 874 | + { |
|
| 875 | + // apply filters (both a global on just the cap, and context specific. Global overrides context specific) |
|
| 876 | + $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id); |
|
| 877 | + $filtered_cap = apply_filters( |
|
| 878 | + 'FHEE__EE_Capabilities__user_can__cap', |
|
| 879 | + $filtered_cap, |
|
| 880 | + $context, |
|
| 881 | + $cap, |
|
| 882 | + $user, |
|
| 883 | + $id |
|
| 884 | + ); |
|
| 885 | + return ! empty($id) |
|
| 886 | + ? user_can($user, $filtered_cap, $id) |
|
| 887 | + : user_can($user, $filtered_cap); |
|
| 888 | + } |
|
| 889 | + |
|
| 890 | + |
|
| 891 | + /** |
|
| 892 | + * Wrapper for the native WP current_user_can_for_blog() method. |
|
| 893 | + * This is provided as a handy method for a couple things: |
|
| 894 | + * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to |
|
| 895 | + * write those filters wherever current_user_can is called). |
|
| 896 | + * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters ) |
|
| 897 | + * |
|
| 898 | + * @since 4.5.0 |
|
| 899 | + * |
|
| 900 | + * @param int $blog_id The blog id that is being checked for. |
|
| 901 | + * @param string $cap The cap being checked. |
|
| 902 | + * @param string $context The context where the current_user_can is being called from. |
|
| 903 | + * @param int $id Optional. Id for item where current_user_can is being called from (used in map_meta_cap() |
|
| 904 | + * filters. |
|
| 905 | + * |
|
| 906 | + * @return bool Whether user can or not. |
|
| 907 | + */ |
|
| 908 | + public function current_user_can_for_blog($blog_id, $cap, $context, $id = 0) |
|
| 909 | + { |
|
| 910 | + $user_can = ! empty($id) |
|
| 911 | + ? current_user_can_for_blog($blog_id, $cap, $id) |
|
| 912 | + : current_user_can($blog_id, $cap); |
|
| 913 | + // apply filters (both a global on just the cap, and context specific. Global overrides context specific) |
|
| 914 | + $user_can = apply_filters( |
|
| 915 | + 'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context, |
|
| 916 | + $user_can, |
|
| 917 | + $blog_id, |
|
| 918 | + $cap, |
|
| 919 | + $id |
|
| 920 | + ); |
|
| 921 | + $user_can = apply_filters( |
|
| 922 | + 'FHEE__EE_Capabilities__current_user_can_for_blog__user_can', |
|
| 923 | + $user_can, |
|
| 924 | + $context, |
|
| 925 | + $blog_id, |
|
| 926 | + $cap, |
|
| 927 | + $id |
|
| 928 | + ); |
|
| 929 | + return $user_can; |
|
| 930 | + } |
|
| 931 | + |
|
| 932 | + |
|
| 933 | + /** |
|
| 934 | + * This helper method just returns an array of registered EE capabilities. |
|
| 935 | + * |
|
| 936 | + * @since 4.5.0 |
|
| 937 | + * @param string $role If empty then the entire role/capability map is returned. |
|
| 938 | + * Otherwise just the capabilities for the given role are returned. |
|
| 939 | + * @return array |
|
| 940 | + * @throws EE_Error |
|
| 941 | + */ |
|
| 942 | + public function get_ee_capabilities($role = 'administrator') |
|
| 943 | + { |
|
| 944 | + if (! $this->initialized) { |
|
| 945 | + $this->init_caps(); |
|
| 946 | + } |
|
| 947 | + if (empty($role)) { |
|
| 948 | + return $this->capabilities_map; |
|
| 949 | + } |
|
| 950 | + return isset($this->capabilities_map[ $role ]) |
|
| 951 | + ? $this->capabilities_map[ $role ] |
|
| 952 | + : array(); |
|
| 953 | + } |
|
| 954 | + |
|
| 955 | + |
|
| 956 | + /** |
|
| 957 | + * @deprecated 4.9.42 |
|
| 958 | + * @param bool $reset If you need to reset Event Espresso's capabilities, |
|
| 959 | + * then please use the init_caps() method with the "$reset" parameter set to "true" |
|
| 960 | + * @param array $caps_map Optional. |
|
| 961 | + * Can be used to send a custom map of roles and capabilities for setting them up. |
|
| 962 | + * Note that this should ONLY be called on activation hook or some other one-time |
|
| 963 | + * task otherwise the caps will be added on every request. |
|
| 964 | + * @return void |
|
| 965 | + * @throws EE_Error |
|
| 966 | + */ |
|
| 967 | + public function init_role_caps($reset = false, $caps_map = array()) |
|
| 968 | + { |
|
| 969 | + // If this method is called directly and reset is set as 'true', |
|
| 970 | + // then display a doing it wrong notice, because we want resets to go through init_caps() |
|
| 971 | + // to guarantee that everything is set up correctly. |
|
| 972 | + // This prevents the capabilities map getting reset incorrectly by direct calls to this method. |
|
| 973 | + if ($reset) { |
|
| 974 | + EE_Error::doing_it_wrong( |
|
| 975 | + __METHOD__, |
|
| 976 | + sprintf( |
|
| 977 | + esc_html__( |
|
| 978 | + 'The "%1$s" parameter for the "%2$s" method is deprecated. If you need to reset Event Espresso\'s capabilities, then please use the "%3$s" method with the "%1$s" parameter set to "%4$s".', |
|
| 979 | + 'event_espresso' |
|
| 980 | + ), |
|
| 981 | + '$reset', |
|
| 982 | + __METHOD__ . '()', |
|
| 983 | + 'EE_Capabilities::init_caps()', |
|
| 984 | + 'true' |
|
| 985 | + ), |
|
| 986 | + '4.9.42', |
|
| 987 | + '5.0.0' |
|
| 988 | + ); |
|
| 989 | + } |
|
| 990 | + $this->addCaps($caps_map); |
|
| 991 | + } |
|
| 992 | 992 | } |
| 993 | 993 | |
| 994 | 994 | |
@@ -1005,142 +1005,142 @@ discard block |
||
| 1005 | 1005 | abstract class EE_Meta_Capability_Map |
| 1006 | 1006 | { |
| 1007 | 1007 | |
| 1008 | - public $meta_cap; |
|
| 1009 | - |
|
| 1010 | - /** |
|
| 1011 | - * @var EEM_Base |
|
| 1012 | - */ |
|
| 1013 | - protected $_model; |
|
| 1014 | - |
|
| 1015 | - protected $_model_name; |
|
| 1016 | - |
|
| 1017 | - public $published_cap = ''; |
|
| 1018 | - |
|
| 1019 | - public $others_cap = ''; |
|
| 1020 | - |
|
| 1021 | - public $private_cap = ''; |
|
| 1022 | - |
|
| 1023 | - |
|
| 1024 | - /** |
|
| 1025 | - * constructor. |
|
| 1026 | - * Receives the setup arguments for the map. |
|
| 1027 | - * |
|
| 1028 | - * @since 4.5.0 |
|
| 1029 | - * |
|
| 1030 | - * @param string $meta_cap What meta capability is this mapping. |
|
| 1031 | - * @param array $map_values array { |
|
| 1032 | - * //array of values that MUST match a count of 4. It's okay to send an empty string for |
|
| 1033 | - * capabilities that don't get mapped to. |
|
| 1034 | - * |
|
| 1035 | - * @type $map_values [0] string A string representing the model name. Required. String's |
|
| 1036 | - * should always be used when Menu Maps are registered via the |
|
| 1037 | - * plugin API as models are not allowed to be instantiated when |
|
| 1038 | - * in maintenance mode 2 (migrations). |
|
| 1039 | - * @type $map_values [1] string represents the capability used for published. Optional. |
|
| 1040 | - * @type $map_values [2] string represents the capability used for "others". Optional. |
|
| 1041 | - * @type $map_values [3] string represents the capability used for private. Optional. |
|
| 1042 | - * } |
|
| 1043 | - * @throws EE_Error |
|
| 1044 | - */ |
|
| 1045 | - public function __construct($meta_cap, $map_values) |
|
| 1046 | - { |
|
| 1047 | - $this->meta_cap = $meta_cap; |
|
| 1048 | - // verify there are four args in the $map_values array; |
|
| 1049 | - if (count($map_values) !== 4) { |
|
| 1050 | - throw new EE_Error( |
|
| 1051 | - sprintf( |
|
| 1052 | - __( |
|
| 1053 | - 'Incoming $map_values array should have a count of four values in it. This is what was given: %s', |
|
| 1054 | - 'event_espresso' |
|
| 1055 | - ), |
|
| 1056 | - '<br>' . print_r($map_values, true) |
|
| 1057 | - ) |
|
| 1058 | - ); |
|
| 1059 | - } |
|
| 1060 | - // set properties |
|
| 1061 | - $this->_model = null; |
|
| 1062 | - $this->_model_name = $map_values[0]; |
|
| 1063 | - $this->published_cap = (string) $map_values[1]; |
|
| 1064 | - $this->others_cap = (string) $map_values[2]; |
|
| 1065 | - $this->private_cap = (string) $map_values[3]; |
|
| 1066 | - } |
|
| 1067 | - |
|
| 1068 | - /** |
|
| 1069 | - * Makes it so this object stops filtering caps |
|
| 1070 | - */ |
|
| 1071 | - public function remove_filters() |
|
| 1072 | - { |
|
| 1073 | - remove_filter('map_meta_cap', array($this, 'map_meta_caps'), 10); |
|
| 1074 | - } |
|
| 1075 | - |
|
| 1076 | - |
|
| 1077 | - /** |
|
| 1078 | - * This method ensures that the $model property is converted from the model name string to a proper EEM_Base class |
|
| 1079 | - * |
|
| 1080 | - * @since 4.5.0 |
|
| 1081 | - * @throws EE_Error |
|
| 1082 | - * |
|
| 1083 | - * @return void |
|
| 1084 | - */ |
|
| 1085 | - public function ensure_is_model() |
|
| 1086 | - { |
|
| 1087 | - // is it already instantiated? |
|
| 1088 | - if ($this->_model instanceof EEM_Base) { |
|
| 1089 | - return; |
|
| 1090 | - } |
|
| 1091 | - // ensure model name is string |
|
| 1092 | - $this->_model_name = (string) $this->_model_name; |
|
| 1093 | - // error proof if the name has EEM in it |
|
| 1094 | - $this->_model_name = str_replace('EEM', '', $this->_model_name); |
|
| 1095 | - $this->_model = EE_Registry::instance()->load_model($this->_model_name); |
|
| 1096 | - if (! $this->_model instanceof EEM_Base) { |
|
| 1097 | - throw new EE_Error( |
|
| 1098 | - sprintf( |
|
| 1099 | - __( |
|
| 1100 | - 'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class. Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s', |
|
| 1101 | - 'event_espresso' |
|
| 1102 | - ), |
|
| 1103 | - get_class($this), |
|
| 1104 | - $this->_model |
|
| 1105 | - ) |
|
| 1106 | - ); |
|
| 1107 | - } |
|
| 1108 | - } |
|
| 1109 | - |
|
| 1110 | - |
|
| 1111 | - /** |
|
| 1112 | - * |
|
| 1113 | - * @see EE_Meta_Capability_Map::_map_meta_caps() for docs on params. |
|
| 1114 | - * @since 4.6.x |
|
| 1115 | - * |
|
| 1116 | - * @param $caps |
|
| 1117 | - * @param $cap |
|
| 1118 | - * @param $user_id |
|
| 1119 | - * @param $args |
|
| 1120 | - * |
|
| 1121 | - * @return array |
|
| 1122 | - */ |
|
| 1123 | - public function map_meta_caps($caps, $cap, $user_id, $args) |
|
| 1124 | - { |
|
| 1125 | - return $this->_map_meta_caps($caps, $cap, $user_id, $args); |
|
| 1126 | - } |
|
| 1127 | - |
|
| 1128 | - |
|
| 1129 | - /** |
|
| 1130 | - * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
| 1131 | - * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
| 1132 | - * |
|
| 1133 | - * @since 4.5.0 |
|
| 1134 | - * @see wp-includes/capabilities.php |
|
| 1135 | - * |
|
| 1136 | - * @param array $caps actual users capabilities |
|
| 1137 | - * @param string $cap initial capability name that is being checked (the "map" key) |
|
| 1138 | - * @param int $user_id The user id |
|
| 1139 | - * @param array $args Adds context to the cap. Typically the object ID. |
|
| 1140 | - * |
|
| 1141 | - * @return array actual users capabilities |
|
| 1142 | - */ |
|
| 1143 | - abstract protected function _map_meta_caps($caps, $cap, $user_id, $args); |
|
| 1008 | + public $meta_cap; |
|
| 1009 | + |
|
| 1010 | + /** |
|
| 1011 | + * @var EEM_Base |
|
| 1012 | + */ |
|
| 1013 | + protected $_model; |
|
| 1014 | + |
|
| 1015 | + protected $_model_name; |
|
| 1016 | + |
|
| 1017 | + public $published_cap = ''; |
|
| 1018 | + |
|
| 1019 | + public $others_cap = ''; |
|
| 1020 | + |
|
| 1021 | + public $private_cap = ''; |
|
| 1022 | + |
|
| 1023 | + |
|
| 1024 | + /** |
|
| 1025 | + * constructor. |
|
| 1026 | + * Receives the setup arguments for the map. |
|
| 1027 | + * |
|
| 1028 | + * @since 4.5.0 |
|
| 1029 | + * |
|
| 1030 | + * @param string $meta_cap What meta capability is this mapping. |
|
| 1031 | + * @param array $map_values array { |
|
| 1032 | + * //array of values that MUST match a count of 4. It's okay to send an empty string for |
|
| 1033 | + * capabilities that don't get mapped to. |
|
| 1034 | + * |
|
| 1035 | + * @type $map_values [0] string A string representing the model name. Required. String's |
|
| 1036 | + * should always be used when Menu Maps are registered via the |
|
| 1037 | + * plugin API as models are not allowed to be instantiated when |
|
| 1038 | + * in maintenance mode 2 (migrations). |
|
| 1039 | + * @type $map_values [1] string represents the capability used for published. Optional. |
|
| 1040 | + * @type $map_values [2] string represents the capability used for "others". Optional. |
|
| 1041 | + * @type $map_values [3] string represents the capability used for private. Optional. |
|
| 1042 | + * } |
|
| 1043 | + * @throws EE_Error |
|
| 1044 | + */ |
|
| 1045 | + public function __construct($meta_cap, $map_values) |
|
| 1046 | + { |
|
| 1047 | + $this->meta_cap = $meta_cap; |
|
| 1048 | + // verify there are four args in the $map_values array; |
|
| 1049 | + if (count($map_values) !== 4) { |
|
| 1050 | + throw new EE_Error( |
|
| 1051 | + sprintf( |
|
| 1052 | + __( |
|
| 1053 | + 'Incoming $map_values array should have a count of four values in it. This is what was given: %s', |
|
| 1054 | + 'event_espresso' |
|
| 1055 | + ), |
|
| 1056 | + '<br>' . print_r($map_values, true) |
|
| 1057 | + ) |
|
| 1058 | + ); |
|
| 1059 | + } |
|
| 1060 | + // set properties |
|
| 1061 | + $this->_model = null; |
|
| 1062 | + $this->_model_name = $map_values[0]; |
|
| 1063 | + $this->published_cap = (string) $map_values[1]; |
|
| 1064 | + $this->others_cap = (string) $map_values[2]; |
|
| 1065 | + $this->private_cap = (string) $map_values[3]; |
|
| 1066 | + } |
|
| 1067 | + |
|
| 1068 | + /** |
|
| 1069 | + * Makes it so this object stops filtering caps |
|
| 1070 | + */ |
|
| 1071 | + public function remove_filters() |
|
| 1072 | + { |
|
| 1073 | + remove_filter('map_meta_cap', array($this, 'map_meta_caps'), 10); |
|
| 1074 | + } |
|
| 1075 | + |
|
| 1076 | + |
|
| 1077 | + /** |
|
| 1078 | + * This method ensures that the $model property is converted from the model name string to a proper EEM_Base class |
|
| 1079 | + * |
|
| 1080 | + * @since 4.5.0 |
|
| 1081 | + * @throws EE_Error |
|
| 1082 | + * |
|
| 1083 | + * @return void |
|
| 1084 | + */ |
|
| 1085 | + public function ensure_is_model() |
|
| 1086 | + { |
|
| 1087 | + // is it already instantiated? |
|
| 1088 | + if ($this->_model instanceof EEM_Base) { |
|
| 1089 | + return; |
|
| 1090 | + } |
|
| 1091 | + // ensure model name is string |
|
| 1092 | + $this->_model_name = (string) $this->_model_name; |
|
| 1093 | + // error proof if the name has EEM in it |
|
| 1094 | + $this->_model_name = str_replace('EEM', '', $this->_model_name); |
|
| 1095 | + $this->_model = EE_Registry::instance()->load_model($this->_model_name); |
|
| 1096 | + if (! $this->_model instanceof EEM_Base) { |
|
| 1097 | + throw new EE_Error( |
|
| 1098 | + sprintf( |
|
| 1099 | + __( |
|
| 1100 | + 'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class. Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s', |
|
| 1101 | + 'event_espresso' |
|
| 1102 | + ), |
|
| 1103 | + get_class($this), |
|
| 1104 | + $this->_model |
|
| 1105 | + ) |
|
| 1106 | + ); |
|
| 1107 | + } |
|
| 1108 | + } |
|
| 1109 | + |
|
| 1110 | + |
|
| 1111 | + /** |
|
| 1112 | + * |
|
| 1113 | + * @see EE_Meta_Capability_Map::_map_meta_caps() for docs on params. |
|
| 1114 | + * @since 4.6.x |
|
| 1115 | + * |
|
| 1116 | + * @param $caps |
|
| 1117 | + * @param $cap |
|
| 1118 | + * @param $user_id |
|
| 1119 | + * @param $args |
|
| 1120 | + * |
|
| 1121 | + * @return array |
|
| 1122 | + */ |
|
| 1123 | + public function map_meta_caps($caps, $cap, $user_id, $args) |
|
| 1124 | + { |
|
| 1125 | + return $this->_map_meta_caps($caps, $cap, $user_id, $args); |
|
| 1126 | + } |
|
| 1127 | + |
|
| 1128 | + |
|
| 1129 | + /** |
|
| 1130 | + * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
| 1131 | + * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
| 1132 | + * |
|
| 1133 | + * @since 4.5.0 |
|
| 1134 | + * @see wp-includes/capabilities.php |
|
| 1135 | + * |
|
| 1136 | + * @param array $caps actual users capabilities |
|
| 1137 | + * @param string $cap initial capability name that is being checked (the "map" key) |
|
| 1138 | + * @param int $user_id The user id |
|
| 1139 | + * @param array $args Adds context to the cap. Typically the object ID. |
|
| 1140 | + * |
|
| 1141 | + * @return array actual users capabilities |
|
| 1142 | + */ |
|
| 1143 | + abstract protected function _map_meta_caps($caps, $cap, $user_id, $args); |
|
| 1144 | 1144 | } |
| 1145 | 1145 | |
| 1146 | 1146 | |
@@ -1156,81 +1156,81 @@ discard block |
||
| 1156 | 1156 | class EE_Meta_Capability_Map_Edit extends EE_Meta_Capability_Map |
| 1157 | 1157 | { |
| 1158 | 1158 | |
| 1159 | - /** |
|
| 1160 | - * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
| 1161 | - * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
| 1162 | - * |
|
| 1163 | - * @since 4.5.0 |
|
| 1164 | - * @see wp-includes/capabilities.php |
|
| 1165 | - * |
|
| 1166 | - * @param array $caps actual users capabilities |
|
| 1167 | - * @param string $cap initial capability name that is being checked (the "map" key) |
|
| 1168 | - * @param int $user_id The user id |
|
| 1169 | - * @param array $args Adds context to the cap. Typically the object ID. |
|
| 1170 | - * |
|
| 1171 | - * @return array actual users capabilities |
|
| 1172 | - */ |
|
| 1173 | - protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
| 1174 | - { |
|
| 1175 | - // only process if we're checking our mapped_cap |
|
| 1176 | - if ($cap !== $this->meta_cap) { |
|
| 1177 | - return $caps; |
|
| 1178 | - } |
|
| 1179 | - |
|
| 1180 | - // okay it is a meta cap so let's first remove that cap from the $caps array. |
|
| 1181 | - if (($key = array_search($cap, $caps)) !== false) { |
|
| 1182 | - unset($caps[ $key ]); |
|
| 1183 | - } |
|
| 1184 | - |
|
| 1185 | - // cast $user_id to int for later explicit comparisons |
|
| 1186 | - $user_id = (int) $user_id; |
|
| 1187 | - |
|
| 1188 | - /** @var EE_Base_Class $obj */ |
|
| 1189 | - $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
|
| 1190 | - // if no obj then let's just do cap |
|
| 1191 | - if (! $obj instanceof EE_Base_Class) { |
|
| 1192 | - $caps[] = 'do_not_allow'; |
|
| 1193 | - return $caps; |
|
| 1194 | - } |
|
| 1195 | - $caps[] = $cap . 's'; |
|
| 1196 | - if ($obj instanceof EE_CPT_Base) { |
|
| 1197 | - // if the item author is set and the user is the author... |
|
| 1198 | - if ($obj->wp_user() && $user_id === $obj->wp_user()) { |
|
| 1199 | - // if obj is published... |
|
| 1200 | - if ($obj->status() === 'publish') { |
|
| 1201 | - $caps[] = $this->published_cap; |
|
| 1202 | - } |
|
| 1203 | - } else { |
|
| 1204 | - // the user is trying to edit someone else's obj |
|
| 1205 | - if (! empty($this->others_cap)) { |
|
| 1206 | - $caps[] = $this->others_cap; |
|
| 1207 | - } |
|
| 1208 | - if (! empty($this->published_cap) && $obj->status() === 'publish') { |
|
| 1209 | - $caps[] = $this->published_cap; |
|
| 1210 | - } elseif (! empty($this->private_cap) && $obj->status() === 'private') { |
|
| 1211 | - $caps[] = $this->private_cap; |
|
| 1212 | - } |
|
| 1213 | - } |
|
| 1214 | - } else { |
|
| 1215 | - // not a cpt object so handled differently |
|
| 1216 | - $has_cap = false; |
|
| 1217 | - try { |
|
| 1218 | - $has_cap = method_exists($obj, 'wp_user') |
|
| 1219 | - && $obj->wp_user() |
|
| 1220 | - && $obj->wp_user() === $user_id; |
|
| 1221 | - } catch (Exception $e) { |
|
| 1222 | - if (WP_DEBUG) { |
|
| 1223 | - EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
| 1224 | - } |
|
| 1225 | - } |
|
| 1226 | - if (! $has_cap) { |
|
| 1227 | - if (! empty($this->others_cap)) { |
|
| 1228 | - $caps[] = $this->others_cap; |
|
| 1229 | - } |
|
| 1230 | - } |
|
| 1231 | - } |
|
| 1232 | - return $caps; |
|
| 1233 | - } |
|
| 1159 | + /** |
|
| 1160 | + * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
| 1161 | + * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
| 1162 | + * |
|
| 1163 | + * @since 4.5.0 |
|
| 1164 | + * @see wp-includes/capabilities.php |
|
| 1165 | + * |
|
| 1166 | + * @param array $caps actual users capabilities |
|
| 1167 | + * @param string $cap initial capability name that is being checked (the "map" key) |
|
| 1168 | + * @param int $user_id The user id |
|
| 1169 | + * @param array $args Adds context to the cap. Typically the object ID. |
|
| 1170 | + * |
|
| 1171 | + * @return array actual users capabilities |
|
| 1172 | + */ |
|
| 1173 | + protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
| 1174 | + { |
|
| 1175 | + // only process if we're checking our mapped_cap |
|
| 1176 | + if ($cap !== $this->meta_cap) { |
|
| 1177 | + return $caps; |
|
| 1178 | + } |
|
| 1179 | + |
|
| 1180 | + // okay it is a meta cap so let's first remove that cap from the $caps array. |
|
| 1181 | + if (($key = array_search($cap, $caps)) !== false) { |
|
| 1182 | + unset($caps[ $key ]); |
|
| 1183 | + } |
|
| 1184 | + |
|
| 1185 | + // cast $user_id to int for later explicit comparisons |
|
| 1186 | + $user_id = (int) $user_id; |
|
| 1187 | + |
|
| 1188 | + /** @var EE_Base_Class $obj */ |
|
| 1189 | + $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
|
| 1190 | + // if no obj then let's just do cap |
|
| 1191 | + if (! $obj instanceof EE_Base_Class) { |
|
| 1192 | + $caps[] = 'do_not_allow'; |
|
| 1193 | + return $caps; |
|
| 1194 | + } |
|
| 1195 | + $caps[] = $cap . 's'; |
|
| 1196 | + if ($obj instanceof EE_CPT_Base) { |
|
| 1197 | + // if the item author is set and the user is the author... |
|
| 1198 | + if ($obj->wp_user() && $user_id === $obj->wp_user()) { |
|
| 1199 | + // if obj is published... |
|
| 1200 | + if ($obj->status() === 'publish') { |
|
| 1201 | + $caps[] = $this->published_cap; |
|
| 1202 | + } |
|
| 1203 | + } else { |
|
| 1204 | + // the user is trying to edit someone else's obj |
|
| 1205 | + if (! empty($this->others_cap)) { |
|
| 1206 | + $caps[] = $this->others_cap; |
|
| 1207 | + } |
|
| 1208 | + if (! empty($this->published_cap) && $obj->status() === 'publish') { |
|
| 1209 | + $caps[] = $this->published_cap; |
|
| 1210 | + } elseif (! empty($this->private_cap) && $obj->status() === 'private') { |
|
| 1211 | + $caps[] = $this->private_cap; |
|
| 1212 | + } |
|
| 1213 | + } |
|
| 1214 | + } else { |
|
| 1215 | + // not a cpt object so handled differently |
|
| 1216 | + $has_cap = false; |
|
| 1217 | + try { |
|
| 1218 | + $has_cap = method_exists($obj, 'wp_user') |
|
| 1219 | + && $obj->wp_user() |
|
| 1220 | + && $obj->wp_user() === $user_id; |
|
| 1221 | + } catch (Exception $e) { |
|
| 1222 | + if (WP_DEBUG) { |
|
| 1223 | + EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
| 1224 | + } |
|
| 1225 | + } |
|
| 1226 | + if (! $has_cap) { |
|
| 1227 | + if (! empty($this->others_cap)) { |
|
| 1228 | + $caps[] = $this->others_cap; |
|
| 1229 | + } |
|
| 1230 | + } |
|
| 1231 | + } |
|
| 1232 | + return $caps; |
|
| 1233 | + } |
|
| 1234 | 1234 | } |
| 1235 | 1235 | |
| 1236 | 1236 | |
@@ -1247,24 +1247,24 @@ discard block |
||
| 1247 | 1247 | class EE_Meta_Capability_Map_Delete extends EE_Meta_Capability_Map_Edit |
| 1248 | 1248 | { |
| 1249 | 1249 | |
| 1250 | - /** |
|
| 1251 | - * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
| 1252 | - * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
| 1253 | - * |
|
| 1254 | - * @since 4.5.0 |
|
| 1255 | - * @see wp-includes/capabilities.php |
|
| 1256 | - * |
|
| 1257 | - * @param array $caps actual users capabilities |
|
| 1258 | - * @param string $cap initial capability name that is being checked (the "map" key) |
|
| 1259 | - * @param int $user_id The user id |
|
| 1260 | - * @param array $args Adds context to the cap. Typically the object ID. |
|
| 1261 | - * |
|
| 1262 | - * @return array actual users capabilities |
|
| 1263 | - */ |
|
| 1264 | - protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
| 1265 | - { |
|
| 1266 | - return parent::_map_meta_caps($caps, $cap, $user_id, $args); |
|
| 1267 | - } |
|
| 1250 | + /** |
|
| 1251 | + * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
| 1252 | + * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
| 1253 | + * |
|
| 1254 | + * @since 4.5.0 |
|
| 1255 | + * @see wp-includes/capabilities.php |
|
| 1256 | + * |
|
| 1257 | + * @param array $caps actual users capabilities |
|
| 1258 | + * @param string $cap initial capability name that is being checked (the "map" key) |
|
| 1259 | + * @param int $user_id The user id |
|
| 1260 | + * @param array $args Adds context to the cap. Typically the object ID. |
|
| 1261 | + * |
|
| 1262 | + * @return array actual users capabilities |
|
| 1263 | + */ |
|
| 1264 | + protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
| 1265 | + { |
|
| 1266 | + return parent::_map_meta_caps($caps, $cap, $user_id, $args); |
|
| 1267 | + } |
|
| 1268 | 1268 | } |
| 1269 | 1269 | |
| 1270 | 1270 | |
@@ -1280,85 +1280,85 @@ discard block |
||
| 1280 | 1280 | class EE_Meta_Capability_Map_Read extends EE_Meta_Capability_Map |
| 1281 | 1281 | { |
| 1282 | 1282 | |
| 1283 | - /** |
|
| 1284 | - * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
| 1285 | - * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
| 1286 | - * |
|
| 1287 | - * @since 4.5.0 |
|
| 1288 | - * @see wp-includes/capabilities.php |
|
| 1289 | - * |
|
| 1290 | - * @param array $caps actual users capabilities |
|
| 1291 | - * @param string $cap initial capability name that is being checked (the "map" key) |
|
| 1292 | - * @param int $user_id The user id |
|
| 1293 | - * @param array $args Adds context to the cap. Typically the object ID. |
|
| 1294 | - * |
|
| 1295 | - * @return array actual users capabilities |
|
| 1296 | - */ |
|
| 1297 | - protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
| 1298 | - { |
|
| 1299 | - // only process if we're checking our mapped cap; |
|
| 1300 | - if ($cap !== $this->meta_cap) { |
|
| 1301 | - return $caps; |
|
| 1302 | - } |
|
| 1303 | - |
|
| 1304 | - // okay it is a meta cap so let's first remove that cap from the $caps array. |
|
| 1305 | - if (($key = array_search($cap, $caps)) !== false) { |
|
| 1306 | - unset($caps[ $key ]); |
|
| 1307 | - } |
|
| 1308 | - |
|
| 1309 | - // cast $user_id to int for later explicit comparisons |
|
| 1310 | - $user_id = (int) $user_id; |
|
| 1311 | - |
|
| 1312 | - $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
|
| 1313 | - // if no obj then let's just do cap |
|
| 1314 | - if (! $obj instanceof EE_Base_Class) { |
|
| 1315 | - $caps[] = 'do_not_allow'; |
|
| 1316 | - return $caps; |
|
| 1317 | - } |
|
| 1318 | - |
|
| 1319 | - $caps[] = $cap . 's'; |
|
| 1320 | - if ($obj instanceof EE_CPT_Base) { |
|
| 1321 | - $status_obj = get_post_status_object($obj->status()); |
|
| 1322 | - if ($status_obj->public) { |
|
| 1323 | - return $caps; |
|
| 1324 | - } |
|
| 1325 | - // if the item author is set and the user is not the author... |
|
| 1326 | - if ($obj->wp_user() && $obj->wp_user() !== $user_id) { |
|
| 1327 | - if (! empty($this->others_cap)) { |
|
| 1328 | - $caps[] = $this->others_cap; |
|
| 1329 | - } |
|
| 1330 | - } |
|
| 1331 | - // yes this means that if users created the private post, they are able to see it regardless of private cap. |
|
| 1332 | - if ($status_obj->private |
|
| 1333 | - && ! empty($this->private_cap) |
|
| 1334 | - && $obj->wp_user() !== $user_id |
|
| 1335 | - ) { |
|
| 1336 | - // the user is trying to view a private object for an object they don't own. |
|
| 1337 | - $caps[] = $this->private_cap; |
|
| 1338 | - } |
|
| 1339 | - } else { |
|
| 1340 | - // not a cpt object so handled differently |
|
| 1341 | - $has_cap = false; |
|
| 1342 | - try { |
|
| 1343 | - $has_cap = method_exists($obj, 'wp_user') |
|
| 1344 | - && $obj->wp_user() |
|
| 1345 | - && $obj->wp_user() === $user_id; |
|
| 1346 | - } catch (Exception $e) { |
|
| 1347 | - if (WP_DEBUG) { |
|
| 1348 | - EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
| 1349 | - } |
|
| 1350 | - } |
|
| 1351 | - if (! $has_cap) { |
|
| 1352 | - if (! empty($this->private_cap)) { |
|
| 1353 | - $caps[] = $this->private_cap; |
|
| 1354 | - } |
|
| 1355 | - if (! empty($this->others_cap)) { |
|
| 1356 | - $caps[] = $this->others_cap; |
|
| 1357 | - } |
|
| 1358 | - } |
|
| 1359 | - } |
|
| 1360 | - return $caps; |
|
| 1361 | - } |
|
| 1283 | + /** |
|
| 1284 | + * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
| 1285 | + * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
| 1286 | + * |
|
| 1287 | + * @since 4.5.0 |
|
| 1288 | + * @see wp-includes/capabilities.php |
|
| 1289 | + * |
|
| 1290 | + * @param array $caps actual users capabilities |
|
| 1291 | + * @param string $cap initial capability name that is being checked (the "map" key) |
|
| 1292 | + * @param int $user_id The user id |
|
| 1293 | + * @param array $args Adds context to the cap. Typically the object ID. |
|
| 1294 | + * |
|
| 1295 | + * @return array actual users capabilities |
|
| 1296 | + */ |
|
| 1297 | + protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
| 1298 | + { |
|
| 1299 | + // only process if we're checking our mapped cap; |
|
| 1300 | + if ($cap !== $this->meta_cap) { |
|
| 1301 | + return $caps; |
|
| 1302 | + } |
|
| 1303 | + |
|
| 1304 | + // okay it is a meta cap so let's first remove that cap from the $caps array. |
|
| 1305 | + if (($key = array_search($cap, $caps)) !== false) { |
|
| 1306 | + unset($caps[ $key ]); |
|
| 1307 | + } |
|
| 1308 | + |
|
| 1309 | + // cast $user_id to int for later explicit comparisons |
|
| 1310 | + $user_id = (int) $user_id; |
|
| 1311 | + |
|
| 1312 | + $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
|
| 1313 | + // if no obj then let's just do cap |
|
| 1314 | + if (! $obj instanceof EE_Base_Class) { |
|
| 1315 | + $caps[] = 'do_not_allow'; |
|
| 1316 | + return $caps; |
|
| 1317 | + } |
|
| 1318 | + |
|
| 1319 | + $caps[] = $cap . 's'; |
|
| 1320 | + if ($obj instanceof EE_CPT_Base) { |
|
| 1321 | + $status_obj = get_post_status_object($obj->status()); |
|
| 1322 | + if ($status_obj->public) { |
|
| 1323 | + return $caps; |
|
| 1324 | + } |
|
| 1325 | + // if the item author is set and the user is not the author... |
|
| 1326 | + if ($obj->wp_user() && $obj->wp_user() !== $user_id) { |
|
| 1327 | + if (! empty($this->others_cap)) { |
|
| 1328 | + $caps[] = $this->others_cap; |
|
| 1329 | + } |
|
| 1330 | + } |
|
| 1331 | + // yes this means that if users created the private post, they are able to see it regardless of private cap. |
|
| 1332 | + if ($status_obj->private |
|
| 1333 | + && ! empty($this->private_cap) |
|
| 1334 | + && $obj->wp_user() !== $user_id |
|
| 1335 | + ) { |
|
| 1336 | + // the user is trying to view a private object for an object they don't own. |
|
| 1337 | + $caps[] = $this->private_cap; |
|
| 1338 | + } |
|
| 1339 | + } else { |
|
| 1340 | + // not a cpt object so handled differently |
|
| 1341 | + $has_cap = false; |
|
| 1342 | + try { |
|
| 1343 | + $has_cap = method_exists($obj, 'wp_user') |
|
| 1344 | + && $obj->wp_user() |
|
| 1345 | + && $obj->wp_user() === $user_id; |
|
| 1346 | + } catch (Exception $e) { |
|
| 1347 | + if (WP_DEBUG) { |
|
| 1348 | + EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__); |
|
| 1349 | + } |
|
| 1350 | + } |
|
| 1351 | + if (! $has_cap) { |
|
| 1352 | + if (! empty($this->private_cap)) { |
|
| 1353 | + $caps[] = $this->private_cap; |
|
| 1354 | + } |
|
| 1355 | + if (! empty($this->others_cap)) { |
|
| 1356 | + $caps[] = $this->others_cap; |
|
| 1357 | + } |
|
| 1358 | + } |
|
| 1359 | + } |
|
| 1360 | + return $caps; |
|
| 1361 | + } |
|
| 1362 | 1362 | } |
| 1363 | 1363 | |
| 1364 | 1364 | |
@@ -1375,56 +1375,56 @@ discard block |
||
| 1375 | 1375 | class EE_Meta_Capability_Map_Messages_Cap extends EE_Meta_Capability_Map |
| 1376 | 1376 | { |
| 1377 | 1377 | |
| 1378 | - /** |
|
| 1379 | - * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
| 1380 | - * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
| 1381 | - * |
|
| 1382 | - * @since 4.5.0 |
|
| 1383 | - * @see wp-includes/capabilities.php |
|
| 1384 | - * |
|
| 1385 | - * @param array $caps actual users capabilities |
|
| 1386 | - * @param string $cap initial capability name that is being checked (the "map" key) |
|
| 1387 | - * @param int $user_id The user id |
|
| 1388 | - * @param array $args Adds context to the cap. Typically the object ID. |
|
| 1389 | - * |
|
| 1390 | - * @return array actual users capabilities |
|
| 1391 | - */ |
|
| 1392 | - protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
| 1393 | - { |
|
| 1394 | - // only process if we're checking our mapped_cap |
|
| 1395 | - if ($cap !== $this->meta_cap) { |
|
| 1396 | - return $caps; |
|
| 1397 | - } |
|
| 1398 | - |
|
| 1399 | - // okay it is a meta cap so let's first remove that cap from the $caps array. |
|
| 1400 | - if (($key = array_search($cap, $caps)) !== false) { |
|
| 1401 | - unset($caps[ $key ]); |
|
| 1402 | - } |
|
| 1403 | - |
|
| 1404 | - // cast $user_id to int for later explicit comparisons |
|
| 1405 | - $user_id = (int) $user_id; |
|
| 1406 | - |
|
| 1407 | - $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
|
| 1408 | - // if no obj then let's just do cap |
|
| 1409 | - if (! $obj instanceof EE_Message_Template_Group) { |
|
| 1410 | - $caps[] = 'do_not_allow'; |
|
| 1411 | - return $caps; |
|
| 1412 | - } |
|
| 1413 | - $caps[] = $cap . 's'; |
|
| 1414 | - $is_global = $obj->is_global(); |
|
| 1415 | - if ($obj->wp_user() && $obj->wp_user() === $user_id) { |
|
| 1416 | - if ($is_global) { |
|
| 1417 | - $caps[] = $this->private_cap; |
|
| 1418 | - } |
|
| 1419 | - } else { |
|
| 1420 | - if ($is_global) { |
|
| 1421 | - $caps[] = $this->private_cap; |
|
| 1422 | - } else { |
|
| 1423 | - $caps[] = $this->others_cap; |
|
| 1424 | - } |
|
| 1425 | - } |
|
| 1426 | - return $caps; |
|
| 1427 | - } |
|
| 1378 | + /** |
|
| 1379 | + * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
| 1380 | + * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
| 1381 | + * |
|
| 1382 | + * @since 4.5.0 |
|
| 1383 | + * @see wp-includes/capabilities.php |
|
| 1384 | + * |
|
| 1385 | + * @param array $caps actual users capabilities |
|
| 1386 | + * @param string $cap initial capability name that is being checked (the "map" key) |
|
| 1387 | + * @param int $user_id The user id |
|
| 1388 | + * @param array $args Adds context to the cap. Typically the object ID. |
|
| 1389 | + * |
|
| 1390 | + * @return array actual users capabilities |
|
| 1391 | + */ |
|
| 1392 | + protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
| 1393 | + { |
|
| 1394 | + // only process if we're checking our mapped_cap |
|
| 1395 | + if ($cap !== $this->meta_cap) { |
|
| 1396 | + return $caps; |
|
| 1397 | + } |
|
| 1398 | + |
|
| 1399 | + // okay it is a meta cap so let's first remove that cap from the $caps array. |
|
| 1400 | + if (($key = array_search($cap, $caps)) !== false) { |
|
| 1401 | + unset($caps[ $key ]); |
|
| 1402 | + } |
|
| 1403 | + |
|
| 1404 | + // cast $user_id to int for later explicit comparisons |
|
| 1405 | + $user_id = (int) $user_id; |
|
| 1406 | + |
|
| 1407 | + $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
|
| 1408 | + // if no obj then let's just do cap |
|
| 1409 | + if (! $obj instanceof EE_Message_Template_Group) { |
|
| 1410 | + $caps[] = 'do_not_allow'; |
|
| 1411 | + return $caps; |
|
| 1412 | + } |
|
| 1413 | + $caps[] = $cap . 's'; |
|
| 1414 | + $is_global = $obj->is_global(); |
|
| 1415 | + if ($obj->wp_user() && $obj->wp_user() === $user_id) { |
|
| 1416 | + if ($is_global) { |
|
| 1417 | + $caps[] = $this->private_cap; |
|
| 1418 | + } |
|
| 1419 | + } else { |
|
| 1420 | + if ($is_global) { |
|
| 1421 | + $caps[] = $this->private_cap; |
|
| 1422 | + } else { |
|
| 1423 | + $caps[] = $this->others_cap; |
|
| 1424 | + } |
|
| 1425 | + } |
|
| 1426 | + return $caps; |
|
| 1427 | + } |
|
| 1428 | 1428 | } |
| 1429 | 1429 | |
| 1430 | 1430 | |
@@ -1441,40 +1441,40 @@ discard block |
||
| 1441 | 1441 | class EE_Meta_Capability_Map_Registration_Form_Cap extends EE_Meta_Capability_Map |
| 1442 | 1442 | { |
| 1443 | 1443 | |
| 1444 | - /** |
|
| 1445 | - * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
| 1446 | - * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
| 1447 | - * |
|
| 1448 | - * @since 4.5.0 |
|
| 1449 | - * @see wp-includes/capabilities.php |
|
| 1450 | - * @param array $caps actual users capabilities |
|
| 1451 | - * @param string $cap initial capability name that is being checked (the "map" key) |
|
| 1452 | - * @param int $user_id The user id |
|
| 1453 | - * @param array $args Adds context to the cap. Typically the object ID. |
|
| 1454 | - * @return array actual users capabilities |
|
| 1455 | - */ |
|
| 1456 | - protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
| 1457 | - { |
|
| 1458 | - // only process if we're checking our mapped_cap |
|
| 1459 | - if ($cap !== $this->meta_cap) { |
|
| 1460 | - return $caps; |
|
| 1461 | - } |
|
| 1462 | - // okay it is a meta cap so let's first remove that cap from the $caps array. |
|
| 1463 | - if (($key = array_search($cap, $caps)) !== false) { |
|
| 1464 | - unset($caps[ $key ]); |
|
| 1465 | - } |
|
| 1466 | - $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
|
| 1467 | - // if no obj then let's just do cap |
|
| 1468 | - if (! $obj instanceof EE_Base_Class) { |
|
| 1469 | - $caps[] = 'do_not_allow'; |
|
| 1470 | - return $caps; |
|
| 1471 | - } |
|
| 1472 | - $caps[] = $cap . 's'; |
|
| 1473 | - $is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false; |
|
| 1474 | - $is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system; |
|
| 1475 | - if ($is_system) { |
|
| 1476 | - $caps[] = $this->private_cap; |
|
| 1477 | - } |
|
| 1478 | - return $caps; |
|
| 1479 | - } |
|
| 1444 | + /** |
|
| 1445 | + * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a |
|
| 1446 | + * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected. |
|
| 1447 | + * |
|
| 1448 | + * @since 4.5.0 |
|
| 1449 | + * @see wp-includes/capabilities.php |
|
| 1450 | + * @param array $caps actual users capabilities |
|
| 1451 | + * @param string $cap initial capability name that is being checked (the "map" key) |
|
| 1452 | + * @param int $user_id The user id |
|
| 1453 | + * @param array $args Adds context to the cap. Typically the object ID. |
|
| 1454 | + * @return array actual users capabilities |
|
| 1455 | + */ |
|
| 1456 | + protected function _map_meta_caps($caps, $cap, $user_id, $args) |
|
| 1457 | + { |
|
| 1458 | + // only process if we're checking our mapped_cap |
|
| 1459 | + if ($cap !== $this->meta_cap) { |
|
| 1460 | + return $caps; |
|
| 1461 | + } |
|
| 1462 | + // okay it is a meta cap so let's first remove that cap from the $caps array. |
|
| 1463 | + if (($key = array_search($cap, $caps)) !== false) { |
|
| 1464 | + unset($caps[ $key ]); |
|
| 1465 | + } |
|
| 1466 | + $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null; |
|
| 1467 | + // if no obj then let's just do cap |
|
| 1468 | + if (! $obj instanceof EE_Base_Class) { |
|
| 1469 | + $caps[] = 'do_not_allow'; |
|
| 1470 | + return $caps; |
|
| 1471 | + } |
|
| 1472 | + $caps[] = $cap . 's'; |
|
| 1473 | + $is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false; |
|
| 1474 | + $is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system; |
|
| 1475 | + if ($is_system) { |
|
| 1476 | + $caps[] = $this->private_cap; |
|
| 1477 | + } |
|
| 1478 | + return $caps; |
|
| 1479 | + } |
|
| 1480 | 1480 | } |
@@ -198,7 +198,7 @@ |
||
| 198 | 198 | * |
| 199 | 199 | * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated. |
| 200 | 200 | * |
| 201 | - * @return int |
|
| 201 | + * @return string |
|
| 202 | 202 | */ |
| 203 | 203 | private function _revenue_per_event_report($period = '-1 month') |
| 204 | 204 | { |
@@ -16,239 +16,239 @@ |
||
| 16 | 16 | { |
| 17 | 17 | |
| 18 | 18 | |
| 19 | - /** |
|
| 20 | - * This is used to hold the reports template data which is setup early in the request. |
|
| 21 | - * |
|
| 22 | - * @type array |
|
| 23 | - */ |
|
| 24 | - protected $_reports_template_data = array(); |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * @Constructor |
|
| 28 | - * @access public |
|
| 29 | - * |
|
| 30 | - * @param bool $routing |
|
| 31 | - * |
|
| 32 | - * @return \Extend_Transactions_Admin_Page |
|
| 33 | - */ |
|
| 34 | - public function __construct($routing = true) |
|
| 35 | - { |
|
| 36 | - parent::__construct($routing); |
|
| 37 | - define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/templates/'); |
|
| 38 | - define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/assets/'); |
|
| 39 | - define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'transactions/assets/'); |
|
| 40 | - } |
|
| 41 | - |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * _extend_page_config |
|
| 45 | - * |
|
| 46 | - * @access protected |
|
| 47 | - * @return void |
|
| 48 | - */ |
|
| 49 | - protected function _extend_page_config() |
|
| 50 | - { |
|
| 51 | - $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'transactions'; |
|
| 52 | - |
|
| 53 | - $new_page_routes = array( |
|
| 54 | - 'reports' => array( |
|
| 55 | - 'func' => '_transaction_reports', |
|
| 56 | - 'capability' => 'ee_read_transactions', |
|
| 57 | - ), |
|
| 58 | - ); |
|
| 59 | - |
|
| 60 | - $this->_page_routes = array_merge($this->_page_routes, $new_page_routes); |
|
| 61 | - |
|
| 62 | - $new_page_config = array( |
|
| 63 | - 'reports' => array( |
|
| 64 | - 'nav' => array( |
|
| 65 | - 'label' => __('Reports', 'event_espresso'), |
|
| 66 | - 'order' => 20, |
|
| 67 | - ), |
|
| 68 | - 'help_tabs' => array( |
|
| 69 | - 'transactions_reports_help_tab' => array( |
|
| 70 | - 'title' => __('Transaction Reports', 'event_espresso'), |
|
| 71 | - 'filename' => 'transactions_reports', |
|
| 72 | - ), |
|
| 73 | - ), |
|
| 74 | - /*'help_tour' => array( 'Transaction_Reports_Help_Tour' ),*/ |
|
| 75 | - 'require_nonce' => false, |
|
| 76 | - ), |
|
| 77 | - ); |
|
| 78 | - $this->_page_config = array_merge($this->_page_config, $new_page_config); |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - |
|
| 82 | - /** |
|
| 83 | - * load_scripts_styles_reports |
|
| 84 | - * |
|
| 85 | - * @access public |
|
| 86 | - * @return void |
|
| 87 | - */ |
|
| 88 | - public function load_scripts_styles_reports() |
|
| 89 | - { |
|
| 90 | - wp_register_script( |
|
| 91 | - 'ee-txn-reports-js', |
|
| 92 | - TXN_CAF_ASSETS_URL . 'ee-transaction-admin-reports.js', |
|
| 93 | - array('google-charts'), |
|
| 94 | - EVENT_ESPRESSO_VERSION, |
|
| 95 | - true |
|
| 96 | - ); |
|
| 97 | - wp_enqueue_script('ee-txn-reports-js'); |
|
| 98 | - $this->_transaction_reports_js_setup(); |
|
| 99 | - EE_Registry::$i18n_js_strings['currency_format'] = EEH_Money::get_format_for_google_charts(); |
|
| 100 | - } |
|
| 101 | - |
|
| 102 | - |
|
| 103 | - /** |
|
| 104 | - * This is called when javascript is being enqueued to setup the various data needed for the reports js. |
|
| 105 | - * Also $this->{$_reports_template_data} property is set for later usage by the _transaction_reports method. |
|
| 106 | - */ |
|
| 107 | - protected function _transaction_reports_js_setup() |
|
| 108 | - { |
|
| 109 | - $this->_reports_template_data['admin_reports'][] = $this->_revenue_per_day_report(); |
|
| 110 | - $this->_reports_template_data['admin_reports'][] = $this->_revenue_per_event_report(); |
|
| 111 | - } |
|
| 112 | - |
|
| 113 | - |
|
| 114 | - /** |
|
| 115 | - * _transaction_reports |
|
| 116 | - * generates Business Reports regarding Transactions |
|
| 117 | - * |
|
| 118 | - * @return void |
|
| 119 | - */ |
|
| 120 | - protected function _transaction_reports() |
|
| 121 | - { |
|
| 122 | - $template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php'; |
|
| 123 | - $this->_admin_page_title = __('Transactions', 'event_espresso'); |
|
| 124 | - $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
|
| 125 | - $template_path, |
|
| 126 | - $this->_reports_template_data, |
|
| 127 | - true |
|
| 128 | - ); |
|
| 129 | - |
|
| 130 | - // the final template wrapper |
|
| 131 | - $this->display_admin_page_with_no_sidebar(); |
|
| 132 | - } |
|
| 133 | - |
|
| 134 | - |
|
| 135 | - /** |
|
| 136 | - * _revenue_per_day_report |
|
| 137 | - * generates Business Report showing Total Revenue per Day. |
|
| 138 | - * |
|
| 139 | - * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated. |
|
| 140 | - * |
|
| 141 | - * @return string |
|
| 142 | - */ |
|
| 143 | - private function _revenue_per_day_report($period = '-1 month') |
|
| 144 | - { |
|
| 145 | - |
|
| 146 | - $report_ID = 'txn-admin-revenue-per-day-report-dv'; |
|
| 147 | - |
|
| 148 | - $TXN = EEM_Transaction::instance(); |
|
| 149 | - |
|
| 150 | - $results = $TXN->get_revenue_per_day_report($period); |
|
| 151 | - $results = (array) $results; |
|
| 152 | - $revenue = array(); |
|
| 153 | - $subtitle = ''; |
|
| 154 | - |
|
| 155 | - if ($results) { |
|
| 156 | - $revenue[] = array( |
|
| 157 | - __('Date (only shows dates that have a revenue greater than 1)', 'event_espresso'), |
|
| 158 | - __('Total Revenue', 'event_espresso'), |
|
| 159 | - ); |
|
| 160 | - foreach ($results as $result) { |
|
| 161 | - $revenue[] = array($result->txnDate, (float) $result->revenue); |
|
| 162 | - } |
|
| 163 | - |
|
| 164 | - // setup the date range. |
|
| 165 | - $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone())); |
|
| 166 | - $ending_date = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone())); |
|
| 167 | - $subtitle = sprintf( |
|
| 168 | - _x('For the period: %s to %s', 'Used to give date range', 'event_espresso'), |
|
| 169 | - $beginning_date->format('Y-m-d'), |
|
| 170 | - $ending_date->format('Y-m-d') |
|
| 171 | - ); |
|
| 172 | - } |
|
| 173 | - |
|
| 174 | - $report_title = esc_html__('Total Revenue per Day', 'event_espresso'); |
|
| 175 | - |
|
| 176 | - $report_params = array( |
|
| 177 | - 'title' => $report_title, |
|
| 178 | - 'subtitle' => $subtitle, |
|
| 179 | - 'id' => $report_ID, |
|
| 180 | - 'revenue' => $revenue, |
|
| 181 | - 'noResults' => empty($revenue) || count($revenue) === 1, |
|
| 182 | - 'noTxnMsg' => sprintf( |
|
| 183 | - __('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'), |
|
| 184 | - '<h2>' . $report_title . '</h2><p>', |
|
| 185 | - '</p>' |
|
| 186 | - ), |
|
| 187 | - ); |
|
| 188 | - wp_localize_script('ee-txn-reports-js', 'txnRevPerDay', $report_params); |
|
| 189 | - |
|
| 190 | - return $report_ID; |
|
| 191 | - } |
|
| 192 | - |
|
| 193 | - |
|
| 194 | - /** |
|
| 195 | - * _revenue_per_event_report |
|
| 196 | - * generates Business Report showing total revenue per event. |
|
| 197 | - * |
|
| 198 | - * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated. |
|
| 199 | - * |
|
| 200 | - * @return int |
|
| 201 | - */ |
|
| 202 | - private function _revenue_per_event_report($period = '-1 month') |
|
| 203 | - { |
|
| 204 | - |
|
| 205 | - $report_ID = 'txn-admin-revenue-per-event-report-dv'; |
|
| 206 | - |
|
| 207 | - $TXN = EEM_Transaction::instance(); |
|
| 208 | - $results = $TXN->get_revenue_per_event_report($period); |
|
| 209 | - $results = (array) $results; |
|
| 210 | - $revenue = array(); |
|
| 211 | - $subtitle = ''; |
|
| 212 | - |
|
| 213 | - if ($results) { |
|
| 214 | - $revenue[] = array( |
|
| 215 | - __('Event (only events that have a revenue greater than 1 are shown)', 'event_espresso'), |
|
| 216 | - __('Total Revenue', 'event_espresso'), |
|
| 217 | - ); |
|
| 218 | - foreach ($results as $result) { |
|
| 219 | - if ($result->revenue > 1) { |
|
| 220 | - $event_name = stripslashes(html_entity_decode($result->event_name, ENT_QUOTES, 'UTF-8')); |
|
| 221 | - $event_name = wp_trim_words($event_name, 5, '...'); |
|
| 222 | - $revenue[] = array($event_name, (float) $result->revenue); |
|
| 223 | - } |
|
| 224 | - } |
|
| 225 | - |
|
| 226 | - // setup the date range. |
|
| 227 | - $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone())); |
|
| 228 | - $ending_date = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone())); |
|
| 229 | - $subtitle = sprintf( |
|
| 230 | - _x('For the period: %s to %s', 'Used to give date range', 'event_espresso'), |
|
| 231 | - $beginning_date->format('Y-m-d'), |
|
| 232 | - $ending_date->format('Y-m-d') |
|
| 233 | - ); |
|
| 234 | - } |
|
| 235 | - |
|
| 236 | - $report_title = esc_html__('Total Revenue per Event', 'event_espresso'); |
|
| 237 | - |
|
| 238 | - $report_params = array( |
|
| 239 | - 'title' => $report_title, |
|
| 240 | - 'subtitle' => $subtitle, |
|
| 241 | - 'id' => $report_ID, |
|
| 242 | - 'revenue' => $revenue, |
|
| 243 | - 'noResults' => empty($revenue), |
|
| 244 | - 'noTxnMsg' => sprintf( |
|
| 245 | - __('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'), |
|
| 246 | - '<h2>' . $report_title . '</h2><p>', |
|
| 247 | - '</p>' |
|
| 248 | - ), |
|
| 249 | - ); |
|
| 250 | - wp_localize_script('ee-txn-reports-js', 'txnRevPerEvent', $report_params); |
|
| 251 | - |
|
| 252 | - return $report_ID; |
|
| 253 | - } |
|
| 19 | + /** |
|
| 20 | + * This is used to hold the reports template data which is setup early in the request. |
|
| 21 | + * |
|
| 22 | + * @type array |
|
| 23 | + */ |
|
| 24 | + protected $_reports_template_data = array(); |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * @Constructor |
|
| 28 | + * @access public |
|
| 29 | + * |
|
| 30 | + * @param bool $routing |
|
| 31 | + * |
|
| 32 | + * @return \Extend_Transactions_Admin_Page |
|
| 33 | + */ |
|
| 34 | + public function __construct($routing = true) |
|
| 35 | + { |
|
| 36 | + parent::__construct($routing); |
|
| 37 | + define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/templates/'); |
|
| 38 | + define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/assets/'); |
|
| 39 | + define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'transactions/assets/'); |
|
| 40 | + } |
|
| 41 | + |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * _extend_page_config |
|
| 45 | + * |
|
| 46 | + * @access protected |
|
| 47 | + * @return void |
|
| 48 | + */ |
|
| 49 | + protected function _extend_page_config() |
|
| 50 | + { |
|
| 51 | + $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'transactions'; |
|
| 52 | + |
|
| 53 | + $new_page_routes = array( |
|
| 54 | + 'reports' => array( |
|
| 55 | + 'func' => '_transaction_reports', |
|
| 56 | + 'capability' => 'ee_read_transactions', |
|
| 57 | + ), |
|
| 58 | + ); |
|
| 59 | + |
|
| 60 | + $this->_page_routes = array_merge($this->_page_routes, $new_page_routes); |
|
| 61 | + |
|
| 62 | + $new_page_config = array( |
|
| 63 | + 'reports' => array( |
|
| 64 | + 'nav' => array( |
|
| 65 | + 'label' => __('Reports', 'event_espresso'), |
|
| 66 | + 'order' => 20, |
|
| 67 | + ), |
|
| 68 | + 'help_tabs' => array( |
|
| 69 | + 'transactions_reports_help_tab' => array( |
|
| 70 | + 'title' => __('Transaction Reports', 'event_espresso'), |
|
| 71 | + 'filename' => 'transactions_reports', |
|
| 72 | + ), |
|
| 73 | + ), |
|
| 74 | + /*'help_tour' => array( 'Transaction_Reports_Help_Tour' ),*/ |
|
| 75 | + 'require_nonce' => false, |
|
| 76 | + ), |
|
| 77 | + ); |
|
| 78 | + $this->_page_config = array_merge($this->_page_config, $new_page_config); |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + |
|
| 82 | + /** |
|
| 83 | + * load_scripts_styles_reports |
|
| 84 | + * |
|
| 85 | + * @access public |
|
| 86 | + * @return void |
|
| 87 | + */ |
|
| 88 | + public function load_scripts_styles_reports() |
|
| 89 | + { |
|
| 90 | + wp_register_script( |
|
| 91 | + 'ee-txn-reports-js', |
|
| 92 | + TXN_CAF_ASSETS_URL . 'ee-transaction-admin-reports.js', |
|
| 93 | + array('google-charts'), |
|
| 94 | + EVENT_ESPRESSO_VERSION, |
|
| 95 | + true |
|
| 96 | + ); |
|
| 97 | + wp_enqueue_script('ee-txn-reports-js'); |
|
| 98 | + $this->_transaction_reports_js_setup(); |
|
| 99 | + EE_Registry::$i18n_js_strings['currency_format'] = EEH_Money::get_format_for_google_charts(); |
|
| 100 | + } |
|
| 101 | + |
|
| 102 | + |
|
| 103 | + /** |
|
| 104 | + * This is called when javascript is being enqueued to setup the various data needed for the reports js. |
|
| 105 | + * Also $this->{$_reports_template_data} property is set for later usage by the _transaction_reports method. |
|
| 106 | + */ |
|
| 107 | + protected function _transaction_reports_js_setup() |
|
| 108 | + { |
|
| 109 | + $this->_reports_template_data['admin_reports'][] = $this->_revenue_per_day_report(); |
|
| 110 | + $this->_reports_template_data['admin_reports'][] = $this->_revenue_per_event_report(); |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + |
|
| 114 | + /** |
|
| 115 | + * _transaction_reports |
|
| 116 | + * generates Business Reports regarding Transactions |
|
| 117 | + * |
|
| 118 | + * @return void |
|
| 119 | + */ |
|
| 120 | + protected function _transaction_reports() |
|
| 121 | + { |
|
| 122 | + $template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php'; |
|
| 123 | + $this->_admin_page_title = __('Transactions', 'event_espresso'); |
|
| 124 | + $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
|
| 125 | + $template_path, |
|
| 126 | + $this->_reports_template_data, |
|
| 127 | + true |
|
| 128 | + ); |
|
| 129 | + |
|
| 130 | + // the final template wrapper |
|
| 131 | + $this->display_admin_page_with_no_sidebar(); |
|
| 132 | + } |
|
| 133 | + |
|
| 134 | + |
|
| 135 | + /** |
|
| 136 | + * _revenue_per_day_report |
|
| 137 | + * generates Business Report showing Total Revenue per Day. |
|
| 138 | + * |
|
| 139 | + * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated. |
|
| 140 | + * |
|
| 141 | + * @return string |
|
| 142 | + */ |
|
| 143 | + private function _revenue_per_day_report($period = '-1 month') |
|
| 144 | + { |
|
| 145 | + |
|
| 146 | + $report_ID = 'txn-admin-revenue-per-day-report-dv'; |
|
| 147 | + |
|
| 148 | + $TXN = EEM_Transaction::instance(); |
|
| 149 | + |
|
| 150 | + $results = $TXN->get_revenue_per_day_report($period); |
|
| 151 | + $results = (array) $results; |
|
| 152 | + $revenue = array(); |
|
| 153 | + $subtitle = ''; |
|
| 154 | + |
|
| 155 | + if ($results) { |
|
| 156 | + $revenue[] = array( |
|
| 157 | + __('Date (only shows dates that have a revenue greater than 1)', 'event_espresso'), |
|
| 158 | + __('Total Revenue', 'event_espresso'), |
|
| 159 | + ); |
|
| 160 | + foreach ($results as $result) { |
|
| 161 | + $revenue[] = array($result->txnDate, (float) $result->revenue); |
|
| 162 | + } |
|
| 163 | + |
|
| 164 | + // setup the date range. |
|
| 165 | + $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone())); |
|
| 166 | + $ending_date = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone())); |
|
| 167 | + $subtitle = sprintf( |
|
| 168 | + _x('For the period: %s to %s', 'Used to give date range', 'event_espresso'), |
|
| 169 | + $beginning_date->format('Y-m-d'), |
|
| 170 | + $ending_date->format('Y-m-d') |
|
| 171 | + ); |
|
| 172 | + } |
|
| 173 | + |
|
| 174 | + $report_title = esc_html__('Total Revenue per Day', 'event_espresso'); |
|
| 175 | + |
|
| 176 | + $report_params = array( |
|
| 177 | + 'title' => $report_title, |
|
| 178 | + 'subtitle' => $subtitle, |
|
| 179 | + 'id' => $report_ID, |
|
| 180 | + 'revenue' => $revenue, |
|
| 181 | + 'noResults' => empty($revenue) || count($revenue) === 1, |
|
| 182 | + 'noTxnMsg' => sprintf( |
|
| 183 | + __('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'), |
|
| 184 | + '<h2>' . $report_title . '</h2><p>', |
|
| 185 | + '</p>' |
|
| 186 | + ), |
|
| 187 | + ); |
|
| 188 | + wp_localize_script('ee-txn-reports-js', 'txnRevPerDay', $report_params); |
|
| 189 | + |
|
| 190 | + return $report_ID; |
|
| 191 | + } |
|
| 192 | + |
|
| 193 | + |
|
| 194 | + /** |
|
| 195 | + * _revenue_per_event_report |
|
| 196 | + * generates Business Report showing total revenue per event. |
|
| 197 | + * |
|
| 198 | + * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated. |
|
| 199 | + * |
|
| 200 | + * @return int |
|
| 201 | + */ |
|
| 202 | + private function _revenue_per_event_report($period = '-1 month') |
|
| 203 | + { |
|
| 204 | + |
|
| 205 | + $report_ID = 'txn-admin-revenue-per-event-report-dv'; |
|
| 206 | + |
|
| 207 | + $TXN = EEM_Transaction::instance(); |
|
| 208 | + $results = $TXN->get_revenue_per_event_report($period); |
|
| 209 | + $results = (array) $results; |
|
| 210 | + $revenue = array(); |
|
| 211 | + $subtitle = ''; |
|
| 212 | + |
|
| 213 | + if ($results) { |
|
| 214 | + $revenue[] = array( |
|
| 215 | + __('Event (only events that have a revenue greater than 1 are shown)', 'event_espresso'), |
|
| 216 | + __('Total Revenue', 'event_espresso'), |
|
| 217 | + ); |
|
| 218 | + foreach ($results as $result) { |
|
| 219 | + if ($result->revenue > 1) { |
|
| 220 | + $event_name = stripslashes(html_entity_decode($result->event_name, ENT_QUOTES, 'UTF-8')); |
|
| 221 | + $event_name = wp_trim_words($event_name, 5, '...'); |
|
| 222 | + $revenue[] = array($event_name, (float) $result->revenue); |
|
| 223 | + } |
|
| 224 | + } |
|
| 225 | + |
|
| 226 | + // setup the date range. |
|
| 227 | + $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone())); |
|
| 228 | + $ending_date = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone())); |
|
| 229 | + $subtitle = sprintf( |
|
| 230 | + _x('For the period: %s to %s', 'Used to give date range', 'event_espresso'), |
|
| 231 | + $beginning_date->format('Y-m-d'), |
|
| 232 | + $ending_date->format('Y-m-d') |
|
| 233 | + ); |
|
| 234 | + } |
|
| 235 | + |
|
| 236 | + $report_title = esc_html__('Total Revenue per Event', 'event_espresso'); |
|
| 237 | + |
|
| 238 | + $report_params = array( |
|
| 239 | + 'title' => $report_title, |
|
| 240 | + 'subtitle' => $subtitle, |
|
| 241 | + 'id' => $report_ID, |
|
| 242 | + 'revenue' => $revenue, |
|
| 243 | + 'noResults' => empty($revenue), |
|
| 244 | + 'noTxnMsg' => sprintf( |
|
| 245 | + __('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'), |
|
| 246 | + '<h2>' . $report_title . '</h2><p>', |
|
| 247 | + '</p>' |
|
| 248 | + ), |
|
| 249 | + ); |
|
| 250 | + wp_localize_script('ee-txn-reports-js', 'txnRevPerEvent', $report_params); |
|
| 251 | + |
|
| 252 | + return $report_ID; |
|
| 253 | + } |
|
| 254 | 254 | } |
@@ -34,9 +34,9 @@ discard block |
||
| 34 | 34 | public function __construct($routing = true) |
| 35 | 35 | { |
| 36 | 36 | parent::__construct($routing); |
| 37 | - define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/templates/'); |
|
| 38 | - define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'transactions/assets/'); |
|
| 39 | - define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'transactions/assets/'); |
|
| 37 | + define('TXN_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND.'transactions/templates/'); |
|
| 38 | + define('TXN_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND.'transactions/assets/'); |
|
| 39 | + define('TXN_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'transactions/assets/'); |
|
| 40 | 40 | } |
| 41 | 41 | |
| 42 | 42 | |
@@ -48,7 +48,7 @@ discard block |
||
| 48 | 48 | */ |
| 49 | 49 | protected function _extend_page_config() |
| 50 | 50 | { |
| 51 | - $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'transactions'; |
|
| 51 | + $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND.'transactions'; |
|
| 52 | 52 | |
| 53 | 53 | $new_page_routes = array( |
| 54 | 54 | 'reports' => array( |
@@ -89,7 +89,7 @@ discard block |
||
| 89 | 89 | { |
| 90 | 90 | wp_register_script( |
| 91 | 91 | 'ee-txn-reports-js', |
| 92 | - TXN_CAF_ASSETS_URL . 'ee-transaction-admin-reports.js', |
|
| 92 | + TXN_CAF_ASSETS_URL.'ee-transaction-admin-reports.js', |
|
| 93 | 93 | array('google-charts'), |
| 94 | 94 | EVENT_ESPRESSO_VERSION, |
| 95 | 95 | true |
@@ -119,7 +119,7 @@ discard block |
||
| 119 | 119 | */ |
| 120 | 120 | protected function _transaction_reports() |
| 121 | 121 | { |
| 122 | - $template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php'; |
|
| 122 | + $template_path = EE_ADMIN_TEMPLATE.'admin_reports.template.php'; |
|
| 123 | 123 | $this->_admin_page_title = __('Transactions', 'event_espresso'); |
| 124 | 124 | $this->_template_args['admin_page_content'] = EEH_Template::display_template( |
| 125 | 125 | $template_path, |
@@ -162,7 +162,7 @@ discard block |
||
| 162 | 162 | } |
| 163 | 163 | |
| 164 | 164 | // setup the date range. |
| 165 | - $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone())); |
|
| 165 | + $beginning_date = new DateTime('now'.$period, new DateTimeZone(EEH_DTT_Helper::get_timezone())); |
|
| 166 | 166 | $ending_date = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone())); |
| 167 | 167 | $subtitle = sprintf( |
| 168 | 168 | _x('For the period: %s to %s', 'Used to give date range', 'event_espresso'), |
@@ -181,7 +181,7 @@ discard block |
||
| 181 | 181 | 'noResults' => empty($revenue) || count($revenue) === 1, |
| 182 | 182 | 'noTxnMsg' => sprintf( |
| 183 | 183 | __('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'), |
| 184 | - '<h2>' . $report_title . '</h2><p>', |
|
| 184 | + '<h2>'.$report_title.'</h2><p>', |
|
| 185 | 185 | '</p>' |
| 186 | 186 | ), |
| 187 | 187 | ); |
@@ -224,7 +224,7 @@ discard block |
||
| 224 | 224 | } |
| 225 | 225 | |
| 226 | 226 | // setup the date range. |
| 227 | - $beginning_date = new DateTime('now' . $period, new DateTimeZone(EEH_DTT_Helper::get_timezone())); |
|
| 227 | + $beginning_date = new DateTime('now'.$period, new DateTimeZone(EEH_DTT_Helper::get_timezone())); |
|
| 228 | 228 | $ending_date = new DateTime('now', new DateTimeZone(EEH_DTT_Helper::get_timezone())); |
| 229 | 229 | $subtitle = sprintf( |
| 230 | 230 | _x('For the period: %s to %s', 'Used to give date range', 'event_espresso'), |
@@ -243,7 +243,7 @@ discard block |
||
| 243 | 243 | 'noResults' => empty($revenue), |
| 244 | 244 | 'noTxnMsg' => sprintf( |
| 245 | 245 | __('%sThere is no revenue to report for the last 30 days.%s', 'event_espresso'), |
| 246 | - '<h2>' . $report_title . '</h2><p>', |
|
| 246 | + '<h2>'.$report_title.'</h2><p>', |
|
| 247 | 247 | '</p>' |
| 248 | 248 | ), |
| 249 | 249 | ); |
@@ -91,7 +91,7 @@ discard block |
||
| 91 | 91 | * |
| 92 | 92 | * @param array $dir_ref original array of paths |
| 93 | 93 | * |
| 94 | - * @return array appended paths |
|
| 94 | + * @return string[] appended paths |
|
| 95 | 95 | */ |
| 96 | 96 | public function messages_autoload_paths($dir_ref) |
| 97 | 97 | { |
@@ -701,7 +701,7 @@ discard block |
||
| 701 | 701 | * @param EE_Question[] $questions An array of questions indexed by answer id. |
| 702 | 702 | * @param EE_Answer[] $answers An array of answer objects |
| 703 | 703 | * @param string $template Template content to be parsed. |
| 704 | - * @param array $valid_shortcodes Valid shortcodes for the template being parsed. |
|
| 704 | + * @param string[] $valid_shortcodes Valid shortcodes for the template being parsed. |
|
| 705 | 705 | * @param array $extra_data Extra data that might be used when parsing the template. |
| 706 | 706 | */ |
| 707 | 707 | protected function _parse_question_list_for_primary_or_recipient_registration( |
@@ -13,803 +13,803 @@ |
||
| 13 | 13 | { |
| 14 | 14 | |
| 15 | 15 | |
| 16 | - /** |
|
| 17 | - * constructor. |
|
| 18 | - */ |
|
| 19 | - public function __construct() |
|
| 20 | - { |
|
| 21 | - $this->_caf_hooks(); |
|
| 22 | - } |
|
| 23 | - |
|
| 24 | - |
|
| 25 | - /** |
|
| 26 | - * Contains all the hooks filters for setting up caffeinated messages functionality. |
|
| 27 | - * |
|
| 28 | - * @since 4.3.2 |
|
| 29 | - * |
|
| 30 | - * @return void |
|
| 31 | - */ |
|
| 32 | - private function _caf_hooks() |
|
| 33 | - { |
|
| 34 | - add_filter('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', array($this, 'messages_autoload_paths'), 5); |
|
| 35 | - add_filter( |
|
| 36 | - 'FHEE__EE_Email_messenger__get_validator_config', |
|
| 37 | - array($this, 'email_messenger_validator_config'), |
|
| 38 | - 5, |
|
| 39 | - 2 |
|
| 40 | - ); |
|
| 41 | - add_filter( |
|
| 42 | - 'FHEE__EE_Email_messenger__get_template_fields', |
|
| 43 | - array($this, 'email_messenger_template_fields'), |
|
| 44 | - 5, |
|
| 45 | - 2 |
|
| 46 | - ); |
|
| 47 | - add_filter( |
|
| 48 | - 'FHEE__EE_Html_messenger__get_template_fields', |
|
| 49 | - array($this, 'html_messenger_template_fields'), |
|
| 50 | - 5, |
|
| 51 | - 2 |
|
| 52 | - ); |
|
| 53 | - add_filter( |
|
| 54 | - 'FHEE__EE_Html_messenger__get_validator_config', |
|
| 55 | - array($this, 'html_messenger_validator_config'), |
|
| 56 | - 5, |
|
| 57 | - 2 |
|
| 58 | - ); |
|
| 59 | - add_filter('FHEE__EE_Pdf_messenger__get_template_fields', array($this, 'pdf_messenger_template_fields'), 5, 2); |
|
| 60 | - add_filter( |
|
| 61 | - 'FHEE__EE_Pdf_messenger__get_validator_config', |
|
| 62 | - array($this, 'pdf_messenger_validator_config'), |
|
| 63 | - 5, |
|
| 64 | - 2 |
|
| 65 | - ); |
|
| 66 | - add_filter( |
|
| 67 | - 'FHEE__EE_Messages_Template_Pack__get_specific_template__contents', |
|
| 68 | - array($this, 'new_default_templates'), |
|
| 69 | - 5, |
|
| 70 | - 7 |
|
| 71 | - ); |
|
| 72 | - add_filter( |
|
| 73 | - 'FHEE__EE_Messages_Base__get_valid_shortcodes', |
|
| 74 | - array($this, 'message_types_valid_shortcodes'), |
|
| 75 | - 5, |
|
| 76 | - 2 |
|
| 77 | - ); |
|
| 78 | - |
|
| 79 | - // shortcode parsers |
|
| 80 | - add_filter('FHEE__EE_Attendee_Shortcodes__shortcodes', array($this, 'additional_attendee_shortcodes'), 5, 2); |
|
| 81 | - add_filter('FHEE__EE_Attendee_Shortcodes__parser_after', array($this, 'additional_attendee_parser'), 5, 5); |
|
| 82 | - add_filter( |
|
| 83 | - 'FHEE__EE_Recipient_List_Shortcodes__shortcodes', |
|
| 84 | - array($this, 'additional_recipient_details_shortcodes'), |
|
| 85 | - 5, |
|
| 86 | - 2 |
|
| 87 | - ); |
|
| 88 | - add_filter( |
|
| 89 | - 'FHEE__EE_Recipient_List_Shortcodes__parser_after', |
|
| 90 | - array($this, 'additional_recipient_details_parser'), |
|
| 91 | - 5, |
|
| 92 | - 5 |
|
| 93 | - ); |
|
| 94 | - add_filter( |
|
| 95 | - 'FHEE__EE_Primary_Registration_List_Shortcodes__shortcodes', |
|
| 96 | - array($this, 'additional_primary_registration_details_shortcodes'), |
|
| 97 | - 5, |
|
| 98 | - 2 |
|
| 99 | - ); |
|
| 100 | - add_filter( |
|
| 101 | - 'FHEE__EE_Primary_Registration_List_Shortcodes__parser_after', |
|
| 102 | - array($this, 'additional_primary_registration_details_parser'), |
|
| 103 | - 5, |
|
| 104 | - 5 |
|
| 105 | - ); |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * @since 4.2.0 |
|
| 109 | - */ |
|
| 110 | - add_filter('FHEE__EE_Datetime_Shortcodes__shortcodes', array($this, 'additional_datetime_shortcodes'), 10, 2); |
|
| 111 | - add_filter('FHEE__EE_Datetime_Shortcodes__parser_after', array($this, 'additional_datetime_parser'), 10, 5); |
|
| 112 | - |
|
| 113 | - /** |
|
| 114 | - * @since 4.3.0 |
|
| 115 | - */ |
|
| 116 | - // eat our own dog food! |
|
| 117 | - add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_message_types')); |
|
| 118 | - add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_shortcodes')); |
|
| 119 | - do_action('EE_Brewing_Regular___messages_caf'); |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - |
|
| 123 | - /** |
|
| 124 | - * This just allows us to add additional paths to the autoloader (EED_Messages::autoload_messages()) for the |
|
| 125 | - * messages system. |
|
| 126 | - * |
|
| 127 | - * @param array $dir_ref original array of paths |
|
| 128 | - * |
|
| 129 | - * @return array appended paths |
|
| 130 | - */ |
|
| 131 | - public function messages_autoload_paths($dir_ref) |
|
| 132 | - { |
|
| 133 | - $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/'; |
|
| 134 | - |
|
| 135 | - return $dir_ref; |
|
| 136 | - } |
|
| 137 | - |
|
| 138 | - |
|
| 139 | - public function email_messenger_validator_config($validator_config, EE_Email_messenger $messenger) |
|
| 140 | - { |
|
| 141 | - $validator_config['attendee_list'] = array( |
|
| 142 | - 'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'), |
|
| 143 | - 'required' => array('[ATTENDEE_LIST]'), |
|
| 144 | - ); |
|
| 145 | - $validator_config['question_list'] = array( |
|
| 146 | - 'shortcodes' => array('question'), |
|
| 147 | - 'required' => array('[QUESTION_LIST]'), |
|
| 148 | - ); |
|
| 149 | - |
|
| 150 | - return $validator_config; |
|
| 151 | - } |
|
| 152 | - |
|
| 153 | - |
|
| 154 | - public function html_messenger_validator_config($validator_config, EE_Html_messenger $messenger) |
|
| 155 | - { |
|
| 156 | - $validator_config['attendee_list'] = array( |
|
| 157 | - 'shortcodes' => array('attendee', 'question_list'), |
|
| 158 | - 'required' => array('[ATTENDEE_LIST]'), |
|
| 159 | - ); |
|
| 160 | - $validator_config['question_list'] = array( |
|
| 161 | - 'shortcodes' => array('question'), |
|
| 162 | - 'required' => array('[QUESTION_LIST]'), |
|
| 163 | - ); |
|
| 164 | - |
|
| 165 | - return $validator_config; |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - |
|
| 169 | - public function pdf_messenger_validator_config($validator_config, EE_Pdf_messenger $messenger) |
|
| 170 | - { |
|
| 171 | - $validator_config['attendee_list'] = array( |
|
| 172 | - 'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'), |
|
| 173 | - 'required' => array('[ATTENDEE_LIST]'), |
|
| 174 | - ); |
|
| 175 | - $validator_config['question_list'] = array( |
|
| 176 | - 'shortcodes' => array('question'), |
|
| 177 | - 'required' => array('[QUESTION_LIST]'), |
|
| 178 | - ); |
|
| 179 | - |
|
| 180 | - return $validator_config; |
|
| 181 | - } |
|
| 182 | - |
|
| 183 | - |
|
| 184 | - public function email_messenger_template_fields($template_fields, EE_Email_messenger $messenger) |
|
| 185 | - { |
|
| 186 | - $template_fields['extra']['content']['question_list'] = array( |
|
| 187 | - 'input' => 'textarea', |
|
| 188 | - 'label' => '[QUESTION_LIST]', |
|
| 189 | - 'type' => 'string', |
|
| 190 | - 'required' => true, |
|
| 191 | - 'validation' => true, |
|
| 192 | - 'format' => '%s', |
|
| 193 | - 'css_class' => 'large-text', |
|
| 194 | - 'rows' => '5', |
|
| 195 | - 'shortcodes_required' => array('[QUESTION_LIST]'), |
|
| 196 | - ); |
|
| 197 | - |
|
| 198 | - return $template_fields; |
|
| 199 | - } |
|
| 200 | - |
|
| 201 | - |
|
| 202 | - public function html_messenger_template_fields($template_fields, EE_Html_messenger $messenger) |
|
| 203 | - { |
|
| 204 | - $template_fields['extra']['content']['question_list'] = array( |
|
| 205 | - 'input' => 'textarea', |
|
| 206 | - 'label' => '[QUESTION_LIST]', |
|
| 207 | - 'type' => 'string', |
|
| 208 | - 'required' => true, |
|
| 209 | - 'validation' => true, |
|
| 210 | - 'format' => '%s', |
|
| 211 | - 'css_class' => 'large-text', |
|
| 212 | - 'rows' => '5', |
|
| 213 | - 'shortcodes_required' => array('[QUESTION_LIST]'), |
|
| 214 | - ); |
|
| 215 | - |
|
| 216 | - return $template_fields; |
|
| 217 | - } |
|
| 218 | - |
|
| 219 | - |
|
| 220 | - public function pdf_messenger_template_fields($template_fields, EE_Pdf_messenger $messenger) |
|
| 221 | - { |
|
| 222 | - $template_fields['extra']['content']['question_list'] = array( |
|
| 223 | - 'input' => 'textarea', |
|
| 224 | - 'label' => '[QUESTION_LIST]', |
|
| 225 | - 'type' => 'string', |
|
| 226 | - 'required' => true, |
|
| 227 | - 'validation' => true, |
|
| 228 | - 'format' => '%s', |
|
| 229 | - 'css_class' => 'large-text', |
|
| 230 | - 'rows' => '5', |
|
| 231 | - 'shortcodes_required' => array('[QUESTION_LIST]'), |
|
| 232 | - ); |
|
| 233 | - |
|
| 234 | - return $template_fields; |
|
| 235 | - } |
|
| 236 | - |
|
| 237 | - |
|
| 238 | - public function new_default_templates( |
|
| 239 | - $contents, |
|
| 240 | - $actual_path, |
|
| 241 | - EE_messenger $messenger, |
|
| 242 | - EE_message_type $message_type, |
|
| 243 | - $field, |
|
| 244 | - $context, |
|
| 245 | - EE_Messages_Template_Pack $template_pack |
|
| 246 | - ) { |
|
| 247 | - |
|
| 248 | - // we're only modifying templates for the default template pack |
|
| 249 | - if (! $template_pack instanceof EE_Messages_Template_Pack_Default) { |
|
| 250 | - return $contents; |
|
| 251 | - } |
|
| 252 | - |
|
| 253 | - // the template file name we're replacing contents for. |
|
| 254 | - $template_file_prefix = $field . '_' . $context; |
|
| 255 | - $msg_prefix = $messenger->name . '_' . $message_type->name . '_'; |
|
| 256 | - |
|
| 257 | - $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/'; |
|
| 258 | - |
|
| 259 | - if ($messenger->name == 'email' && $message_type->name == 'registration') { |
|
| 260 | - switch ($template_file_prefix) { |
|
| 261 | - case 'question_list_admin': |
|
| 262 | - case 'question_list_attendee': |
|
| 263 | - case 'question_list_primary_attendee': |
|
| 264 | - $path = $base_path . $msg_prefix . 'question_list.template.php'; |
|
| 265 | - $contents = EEH_Template::display_template($path, array(), true); |
|
| 266 | - break; |
|
| 267 | - |
|
| 268 | - case 'attendee_list_primary_attendee': |
|
| 269 | - $path = $base_path . $msg_prefix . 'attendee_list.template.php'; |
|
| 270 | - $contents = EEH_Template::display_template($path, array(), true); |
|
| 271 | - break; |
|
| 272 | - |
|
| 273 | - case 'attendee_list_admin': |
|
| 274 | - $path = $base_path . $msg_prefix . 'attendee_list_admin.template.php'; |
|
| 275 | - $contents = EEH_Template::display_template( |
|
| 276 | - $path, |
|
| 277 | - array(), |
|
| 278 | - true |
|
| 279 | - ); |
|
| 280 | - break; |
|
| 281 | - |
|
| 282 | - case 'attendee_list_attendee': |
|
| 283 | - $contents = ''; |
|
| 284 | - break; |
|
| 285 | - |
|
| 286 | - case 'event_list_attendee': |
|
| 287 | - $path = $base_path . $msg_prefix . 'event_list_attendee.template.php'; |
|
| 288 | - $contents = EEH_Template::display_template($path, array(), true); |
|
| 289 | - break; |
|
| 290 | - } |
|
| 291 | - } elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') { |
|
| 292 | - switch ($template_file_prefix) { |
|
| 293 | - case 'content_attendee': |
|
| 294 | - $path = $base_path . $msg_prefix . 'content.template.php'; |
|
| 295 | - $contents = EEH_Template::display_template($path, array(), true); |
|
| 296 | - break; |
|
| 297 | - |
|
| 298 | - case 'newsletter_content_attendee': |
|
| 299 | - $path = $base_path . $msg_prefix . 'newsletter_content.template.php'; |
|
| 300 | - $contents = EEH_Template::display_template($path, array(), true); |
|
| 301 | - break; |
|
| 302 | - |
|
| 303 | - case 'newsletter_subject_attendee': |
|
| 304 | - $path = $base_path . $msg_prefix . 'subject.template.php'; |
|
| 305 | - $contents = EEH_Template::display_template($path, array(), true); |
|
| 306 | - break; |
|
| 307 | - } |
|
| 308 | - } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') { |
|
| 309 | - switch ($template_file_prefix) { |
|
| 310 | - case 'attendee_list_purchaser': |
|
| 311 | - $path = $base_path . $msg_prefix . 'attendee_list.template.php'; |
|
| 312 | - $contents = EEH_Template::display_template($path, array(), true); |
|
| 313 | - break; |
|
| 314 | - } |
|
| 315 | - } |
|
| 316 | - |
|
| 317 | - return $contents; |
|
| 318 | - } |
|
| 319 | - |
|
| 320 | - |
|
| 321 | - public function message_types_valid_shortcodes($valid_shortcodes, EE_Messages_Base $msg) |
|
| 322 | - { |
|
| 323 | - // make sure question_list and question are ONLY added for the core message types. Any other message types will have to explicitly set question_list as a valid shortcode. |
|
| 324 | - $include_with = array( |
|
| 325 | - 'registration', |
|
| 326 | - 'cancelled_registration', |
|
| 327 | - 'declined_registration', |
|
| 328 | - 'not_approved_registration', |
|
| 329 | - 'payment_declined', |
|
| 330 | - 'payment_failed', |
|
| 331 | - 'payment_cancelled', |
|
| 332 | - 'payment', |
|
| 333 | - 'payment_reminder', |
|
| 334 | - 'pending_approval', |
|
| 335 | - 'registration_summary', |
|
| 336 | - 'invoice', |
|
| 337 | - 'receipt', |
|
| 338 | - ); |
|
| 339 | - if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) { |
|
| 340 | - $contexts = array_keys($msg->get_contexts()); |
|
| 341 | - foreach ($contexts as $context) { |
|
| 342 | - $valid_shortcodes[ $context ][] = 'question_list'; |
|
| 343 | - $valid_shortcodes[ $context ][] = 'question'; |
|
| 344 | - } |
|
| 345 | - } |
|
| 346 | - |
|
| 347 | - return $valid_shortcodes; |
|
| 348 | - } |
|
| 349 | - |
|
| 350 | - |
|
| 351 | - public function additional_attendee_shortcodes($shortcodes, $shortcode_parser) |
|
| 352 | - { |
|
| 353 | - $shortcodes['[ANSWER_*]'] = __( |
|
| 354 | - 'This is a special dynamic shortcode. Right after the "*", add the exact text of a existing question, and if there is an answer for that question for this registrant, that will take the place of this shortcode.', |
|
| 355 | - 'event_espresso' |
|
| 356 | - ); |
|
| 357 | - |
|
| 358 | - return $shortcodes; |
|
| 359 | - } |
|
| 360 | - |
|
| 361 | - |
|
| 362 | - public function additional_attendee_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser) |
|
| 363 | - { |
|
| 364 | - |
|
| 365 | - if (strpos($shortcode, '[ANSWER_*') === false |
|
| 366 | - || ! isset($extra_data['data']->questions) |
|
| 367 | - || ! isset($extra_data['data']->registrations) |
|
| 368 | - ) { |
|
| 369 | - return $parsed; |
|
| 370 | - } |
|
| 371 | - |
|
| 372 | - // let's get the question from the code. |
|
| 373 | - $shortcode = str_replace('[ANSWER_*', '', $shortcode); |
|
| 374 | - $shortcode = trim(str_replace(']', '', $shortcode)); |
|
| 375 | - |
|
| 376 | - $registration = $data instanceof EE_Registration ? $data : null; |
|
| 377 | - $registration = ! $registration instanceof EE_Registration && is_array( |
|
| 378 | - $extra_data |
|
| 379 | - ) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Registration ? $extra_data['data'] : $registration; |
|
| 380 | - |
|
| 381 | - $aee = $data instanceof EE_Messages_Addressee ? $data : null; |
|
| 382 | - $aee = ! $aee instanceof EE_Messages_Addressee && is_array( |
|
| 383 | - $extra_data |
|
| 384 | - ) && isset($extra_data['data']) ? $extra_data['data'] : $aee; |
|
| 385 | - |
|
| 386 | - if (! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) { |
|
| 387 | - return $parsed; |
|
| 388 | - } |
|
| 389 | - |
|
| 390 | - // now let's figure out which question has this text. |
|
| 391 | - foreach ($aee->questions as $ansid => $question) { |
|
| 392 | - if ($question instanceof EE_Question |
|
| 393 | - && trim($question->display_text()) == trim($shortcode) |
|
| 394 | - && isset($aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ]) |
|
| 395 | - ) { |
|
| 396 | - return $aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ]->get_pretty( |
|
| 397 | - 'ANS_value', |
|
| 398 | - 'no_wpautop' |
|
| 399 | - ); |
|
| 400 | - } |
|
| 401 | - } |
|
| 402 | - |
|
| 403 | - // nothing! |
|
| 404 | - return $parsed; |
|
| 405 | - } |
|
| 406 | - |
|
| 407 | - |
|
| 408 | - /** |
|
| 409 | - * Callback for additional shortcodes filter for adding additional datetime shortcodes. |
|
| 410 | - * |
|
| 411 | - * @since 4.2 |
|
| 412 | - * |
|
| 413 | - * @param array $shortcodes array of shortcodes and |
|
| 414 | - * descriptions |
|
| 415 | - * @param EE_Datetime_Shortcodes $shortcode_parser EE_Shortcodes object |
|
| 416 | - * |
|
| 417 | - * @return array array of shortcodes and |
|
| 418 | - * descriptions |
|
| 419 | - */ |
|
| 420 | - public function additional_datetime_shortcodes($shortcodes, $shortcode_parser) |
|
| 421 | - { |
|
| 422 | - $shortcodes['[DTT_NAME]'] = __( |
|
| 423 | - 'This will be parsed to the Title given for a Datetime', |
|
| 424 | - 'event_espresso' |
|
| 425 | - ); |
|
| 426 | - $shortcodes['[DTT_DESCRIPTION]'] = __( |
|
| 427 | - 'This will be parsed to the description for a Datetime', |
|
| 428 | - 'event_espresso' |
|
| 429 | - ); |
|
| 430 | - $shortcodes['[DTT_NAME_OR_DATES]'] = __( |
|
| 431 | - 'When parsed, if the Datetime has a name, it is used, otherwise a formatted string including the start date and end date will be used.', |
|
| 432 | - 'event_espresso' |
|
| 433 | - ); |
|
| 434 | - |
|
| 435 | - return $shortcodes; |
|
| 436 | - } |
|
| 437 | - |
|
| 438 | - |
|
| 439 | - /** |
|
| 440 | - * Callback for additional shortcodes parser filter used for adding parser for new |
|
| 441 | - * Datetime shortcodes |
|
| 442 | - * |
|
| 443 | - * @since 4.2 |
|
| 444 | - * |
|
| 445 | - * @param string $parsed The finished parsed string for the given shortcode. |
|
| 446 | - * @param string $shortcode The shortcode being parsed. |
|
| 447 | - * @param object $data The incoming data object for the Shortcode Parser. |
|
| 448 | - * @param object $extra_data The incoming extra date object for the Shortcode |
|
| 449 | - * Parser. |
|
| 450 | - * @param EE_Datetime_Shortcodes $shortcode_parser |
|
| 451 | - * |
|
| 452 | - * @return string The new parsed string. |
|
| 453 | - */ |
|
| 454 | - public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser) |
|
| 455 | - { |
|
| 456 | - |
|
| 457 | - if (! $data instanceof EE_Datetime) { |
|
| 458 | - return ''; // get out because we can only parse with the datetime object. |
|
| 459 | - } |
|
| 460 | - |
|
| 461 | - switch ($shortcode) { |
|
| 462 | - case '[DTT_NAME]': |
|
| 463 | - return $data->name(); |
|
| 464 | - break; |
|
| 465 | - case '[DTT_DESCRIPTION]': |
|
| 466 | - return $data->description(); |
|
| 467 | - break; |
|
| 468 | - case '[DTT_NAME_OR_DATES]': |
|
| 469 | - return $data->get_dtt_display_name(true); |
|
| 470 | - break; |
|
| 471 | - default: |
|
| 472 | - return $parsed; |
|
| 473 | - break; |
|
| 474 | - } |
|
| 475 | - } |
|
| 476 | - |
|
| 477 | - |
|
| 478 | - public function additional_recipient_details_shortcodes($shortcodes, $shortcode_parser) |
|
| 479 | - { |
|
| 480 | - $shortcodes['[RECIPIENT_QUESTION_LIST]'] = __( |
|
| 481 | - 'This is used to indicate where you want the list of questions and answers to show for the person receiving the message.', |
|
| 482 | - 'event_espresso' |
|
| 483 | - ); |
|
| 484 | - |
|
| 485 | - return $shortcodes; |
|
| 486 | - } |
|
| 487 | - |
|
| 488 | - |
|
| 489 | - /** |
|
| 490 | - * Callback for FHEE__EE_Recipient_List_Shortcodes__parser_after filter (dynamic filter). |
|
| 491 | - * |
|
| 492 | - * @param string $parsed The original parsed content for the shortcode |
|
| 493 | - * @param string $shortcode The shortcode being parsed |
|
| 494 | - * @param array $data The shortcode parser data array |
|
| 495 | - * @param array $extra_data The shortcode parser extra data array |
|
| 496 | - * @param \EE_Shortcodes $shortcode_parser Shortcode parser. |
|
| 497 | - * |
|
| 498 | - * @return string |
|
| 499 | - */ |
|
| 500 | - public function additional_recipient_details_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser) |
|
| 501 | - { |
|
| 502 | - |
|
| 503 | - if (array($data) && ! isset($data['data'])) { |
|
| 504 | - return $parsed; |
|
| 505 | - } |
|
| 506 | - |
|
| 507 | - $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null; |
|
| 508 | - $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient; |
|
| 509 | - |
|
| 510 | - if (! $recipient instanceof EE_Messages_Addressee) { |
|
| 511 | - return $parsed; |
|
| 512 | - } |
|
| 513 | - |
|
| 514 | - switch ($shortcode) { |
|
| 515 | - case '[RECIPIENT_QUESTION_LIST]': |
|
| 516 | - $att = $recipient->att_obj; |
|
| 517 | - $registrations_on_attendee = $att instanceof EE_Attendee |
|
| 518 | - ? $recipient->attendees[ $att->ID() ]['reg_objs'] |
|
| 519 | - : array(); |
|
| 520 | - $registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee; |
|
| 521 | - $answers = array(); |
|
| 522 | - |
|
| 523 | - $template = is_array($data['template']) && isset($data['template']['question_list']) |
|
| 524 | - ? $data['template']['question_list'] |
|
| 525 | - : $extra_data['template']['question_list']; |
|
| 526 | - $valid_shortcodes = array('question'); |
|
| 527 | - |
|
| 528 | - // if the context is main_content then get all answers for all registrations on this attendee |
|
| 529 | - if ($data['data'] instanceof EE_Messages_Addressee) { |
|
| 530 | - foreach ($registrations_on_attendee as $reg) { |
|
| 531 | - if ($reg instanceof EE_Registration) { |
|
| 532 | - $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs']) |
|
| 533 | - ? $recipient->registrations[ $reg->ID() ]['ans_objs'] |
|
| 534 | - : array(); |
|
| 535 | - foreach ($anss as $ans) { |
|
| 536 | - if ($ans instanceof EE_Answer) { |
|
| 537 | - $answers[ $ans->ID() ] = $ans; |
|
| 538 | - } |
|
| 539 | - } |
|
| 540 | - } |
|
| 541 | - } |
|
| 542 | - } |
|
| 543 | - |
|
| 544 | - // if the context is the event list parser, then let's return just the answers for all registrations attached to the recipient for that event. |
|
| 545 | - if ($data['data'] instanceof EE_Event) { |
|
| 546 | - $event = $data['data']; |
|
| 547 | - foreach ($registrations_on_attendee as $reg) { |
|
| 548 | - if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) { |
|
| 549 | - $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs']) |
|
| 550 | - ? $recipient->registrations[ $reg->ID() ]['ans_objs'] |
|
| 551 | - : array(); |
|
| 552 | - foreach ($anss as $ans) { |
|
| 553 | - if ($ans instanceof EE_Answer) { |
|
| 554 | - $answers[ $ans->ID() ] = $ans; |
|
| 555 | - } |
|
| 556 | - } |
|
| 557 | - } |
|
| 558 | - } |
|
| 559 | - } |
|
| 560 | - |
|
| 561 | - $questions = $questions = isset($recipient->questions) ? $recipient->questions : array(); |
|
| 562 | - |
|
| 563 | - // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee |
|
| 564 | - // object on it. |
|
| 565 | - if (! isset($extra_data['data'])) { |
|
| 566 | - $extra_data['data'] = $recipient; |
|
| 567 | - } |
|
| 568 | - |
|
| 569 | - return $this->_parse_question_list_for_primary_or_recipient_registration( |
|
| 570 | - $shortcode_parser, |
|
| 571 | - $questions, |
|
| 572 | - $answers, |
|
| 573 | - $template, |
|
| 574 | - $valid_shortcodes, |
|
| 575 | - $extra_data |
|
| 576 | - ); |
|
| 577 | - break; |
|
| 578 | - |
|
| 579 | - default: |
|
| 580 | - return $parsed; |
|
| 581 | - break; |
|
| 582 | - } |
|
| 583 | - } |
|
| 584 | - |
|
| 585 | - |
|
| 586 | - public function additional_primary_registration_details_shortcodes($shortcodes, $shortcode_parser) |
|
| 587 | - { |
|
| 588 | - $shortcodes['[PRIMARY_REGISTRANT_QUESTION_LIST]'] = __( |
|
| 589 | - 'This is used to indicate the questions and answers for the primary_registrant. It should be placed in the "[attendee_list]" field', |
|
| 590 | - 'event_espresso' |
|
| 591 | - ); |
|
| 592 | - |
|
| 593 | - return $shortcodes; |
|
| 594 | - } |
|
| 595 | - |
|
| 596 | - |
|
| 597 | - /** |
|
| 598 | - * Callback for FHEE__EE_Primary_Registration_List_Shortcodes__parser_after filter (dynamic filter). |
|
| 599 | - * |
|
| 600 | - * @param string $parsed The original parsed content for the shortcode |
|
| 601 | - * @param string $shortcode The shortcode being parsed |
|
| 602 | - * @param array $data The shortcode parser data array |
|
| 603 | - * @param array $extra_data The shortcode parser extra data array |
|
| 604 | - * @param \EE_Shortcodes $shortcode_parser Shortcode parser. |
|
| 605 | - * |
|
| 606 | - * @return string |
|
| 607 | - */ |
|
| 608 | - public function additional_primary_registration_details_parser( |
|
| 609 | - $parsed, |
|
| 610 | - $shortcode, |
|
| 611 | - $data, |
|
| 612 | - $extra_data, |
|
| 613 | - $shortcode_parser |
|
| 614 | - ) { |
|
| 615 | - if (array($data) && ! isset($data['data'])) { |
|
| 616 | - return $parsed; |
|
| 617 | - } |
|
| 618 | - |
|
| 619 | - $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null; |
|
| 620 | - $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient; |
|
| 621 | - |
|
| 622 | - if (! $recipient instanceof EE_Messages_Addressee) { |
|
| 623 | - return $parsed; |
|
| 624 | - } |
|
| 625 | - |
|
| 626 | - switch ($shortcode) { |
|
| 627 | - case '[PRIMARY_REGISTRANT_QUESTION_LIST]': |
|
| 628 | - if (! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) { |
|
| 629 | - return ''; |
|
| 630 | - } |
|
| 631 | - $registration = $recipient->primary_reg_obj; |
|
| 632 | - $answers = isset($recipient->registrations[ $registration->ID() ]['ans_objs']) |
|
| 633 | - ? $recipient->registrations[ $registration->ID() ]['ans_objs'] |
|
| 634 | - : array(); |
|
| 635 | - if (empty($answers)) { |
|
| 636 | - return ''; |
|
| 637 | - } |
|
| 638 | - $template = is_array($data['template']) && isset($data['template']['question_list']) |
|
| 639 | - ? $data['template']['question_list'] |
|
| 640 | - : $extra_data['template']['question_list']; |
|
| 641 | - $valid_shortcodes = array('question'); |
|
| 642 | - $answers = $recipient->registrations[ $registration->ID() ]['ans_objs']; |
|
| 643 | - $questions = isset($recipient->questions) ? $recipient->questions : array(); |
|
| 644 | - // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee |
|
| 645 | - // object on it. |
|
| 646 | - if (! isset($extra_data['data'])) { |
|
| 647 | - $extra_data['data'] = $recipient; |
|
| 648 | - } |
|
| 649 | - return $this->_parse_question_list_for_primary_or_recipient_registration( |
|
| 650 | - $shortcode_parser, |
|
| 651 | - $questions, |
|
| 652 | - $answers, |
|
| 653 | - $template, |
|
| 654 | - $valid_shortcodes, |
|
| 655 | - $extra_data |
|
| 656 | - ); |
|
| 657 | - break; |
|
| 658 | - |
|
| 659 | - default: |
|
| 660 | - return $parsed; |
|
| 661 | - break; |
|
| 662 | - } |
|
| 663 | - } |
|
| 664 | - |
|
| 665 | - |
|
| 666 | - /** |
|
| 667 | - * Takes care of registering the message types that are only available in caffeinated EE. |
|
| 668 | - * |
|
| 669 | - * @since 4.3.2 |
|
| 670 | - * |
|
| 671 | - * @return void |
|
| 672 | - */ |
|
| 673 | - public function register_caf_message_types() |
|
| 674 | - { |
|
| 675 | - // register newsletter message type |
|
| 676 | - $setup_args = array( |
|
| 677 | - 'mtfilename' => 'EE_Newsletter_message_type.class.php', |
|
| 678 | - 'autoloadpaths' => array( |
|
| 679 | - EE_CAF_LIBRARIES . 'messages/message_type/newsletter/', |
|
| 680 | - ), |
|
| 681 | - 'messengers_to_activate_with' => array('email'), |
|
| 682 | - 'messengers_to_validate_with' => array('email'), |
|
| 683 | - 'messengers_supporting_default_template_pack_with' => array('email'), |
|
| 684 | - ); |
|
| 685 | - EE_Register_Message_Type::register('newsletter', $setup_args); |
|
| 686 | - |
|
| 687 | - // register payment reminder message type |
|
| 688 | - $setup_args = array( |
|
| 689 | - 'mtfilename' => 'EE_Payment_Reminder_message_type.class.php', |
|
| 690 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'), |
|
| 691 | - 'messengers_to_activate_with' => array('email'), |
|
| 692 | - 'messengers_to_validate_with' => array('email'), |
|
| 693 | - 'messengers_supporting_default_template_pack_with' => array('email'), |
|
| 694 | - ); |
|
| 695 | - EE_Register_Message_Type::register('payment_reminder', $setup_args); |
|
| 696 | - |
|
| 697 | - // register payment declined message type |
|
| 698 | - $setup_args = array( |
|
| 699 | - 'mtfilename' => 'EE_Payment_Declined_message_type.class.php', |
|
| 700 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'), |
|
| 701 | - 'messengers_to_activate_with' => array('email'), |
|
| 702 | - 'messengers_to_validate_with' => array('email'), |
|
| 703 | - 'messengers_supporting_default_template_pack_with' => array('email'), |
|
| 704 | - ); |
|
| 705 | - EE_Register_Message_Type::register('payment_declined', $setup_args); |
|
| 706 | - |
|
| 707 | - // register registration declined message type |
|
| 708 | - $setup_args = array( |
|
| 709 | - 'mtfilename' => 'EE_Declined_Registration_message_type.class.php', |
|
| 710 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'), |
|
| 711 | - 'messengers_to_activate_with' => array('email'), |
|
| 712 | - 'messengers_to_validate_with' => array('email'), |
|
| 713 | - 'messengers_supporting_default_template_pack_with' => array('email'), |
|
| 714 | - ); |
|
| 715 | - EE_Register_Message_Type::register('declined_registration', $setup_args); |
|
| 716 | - |
|
| 717 | - // register registration cancelled message type |
|
| 718 | - $setup_args = array( |
|
| 719 | - 'mtfilename' => 'EE_Cancelled_Registration_message_type.class.php', |
|
| 720 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'), |
|
| 721 | - 'messengers_to_activate_with' => array('email'), |
|
| 722 | - 'messengers_to_validate_with' => array('email'), |
|
| 723 | - 'messengers_supporting_default_template_pack_with' => array('email'), |
|
| 724 | - ); |
|
| 725 | - EE_Register_Message_Type::register('cancelled_registration', $setup_args); |
|
| 726 | - |
|
| 727 | - |
|
| 728 | - // register payment failed message type |
|
| 729 | - $setup_args = array( |
|
| 730 | - 'mtfilename' => 'EE_Payment_Failed_message_type.class.php', |
|
| 731 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'), |
|
| 732 | - 'messengers_to_activate_with' => array('email'), |
|
| 733 | - 'messengers_to_validate_with' => array('email'), |
|
| 734 | - 'messengers_supporting_default_template_pack_with' => array('email'), |
|
| 735 | - ); |
|
| 736 | - EE_Register_Message_Type::register('payment_failed', $setup_args); |
|
| 737 | - |
|
| 738 | - // register payment declined message type |
|
| 739 | - $setup_args = array( |
|
| 740 | - 'mtfilename' => 'EE_Payment_Cancelled_message_type.class.php', |
|
| 741 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'), |
|
| 742 | - 'messengers_to_activate_with' => array('email'), |
|
| 743 | - 'messengers_to_validate_with' => array('email'), |
|
| 744 | - 'messengers_supporting_default_template_pack_with' => array('email'), |
|
| 745 | - ); |
|
| 746 | - EE_Register_Message_Type::register('payment_cancelled', $setup_args); |
|
| 747 | - } |
|
| 748 | - |
|
| 749 | - |
|
| 750 | - /** |
|
| 751 | - * Takes care of registering the shortcode libraries implemented with caffeinated EE and set up related items. |
|
| 752 | - * |
|
| 753 | - * @since 4.3.2 |
|
| 754 | - * |
|
| 755 | - * @return void |
|
| 756 | - */ |
|
| 757 | - public function register_caf_shortcodes() |
|
| 758 | - { |
|
| 759 | - $setup_args = array( |
|
| 760 | - 'autoloadpaths' => array( |
|
| 761 | - EE_CAF_LIBRARIES . 'shortcodes/', |
|
| 762 | - ), |
|
| 763 | - 'msgr_validator_callback' => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'), |
|
| 764 | - 'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'), |
|
| 765 | - 'list_type_shortcodes' => array('[NEWSLETTER_CONTENT]'), |
|
| 766 | - ); |
|
| 767 | - EE_Register_Messages_Shortcode_Library::register('newsletter', $setup_args); |
|
| 768 | - } |
|
| 769 | - |
|
| 770 | - |
|
| 771 | - /** |
|
| 772 | - * Parses a question list shortcode using given data and template |
|
| 773 | - * |
|
| 774 | - * @param \EE_Shortcodes $shortcode_parser |
|
| 775 | - * @param EE_Question[] $questions An array of questions indexed by answer id. |
|
| 776 | - * @param EE_Answer[] $answers An array of answer objects |
|
| 777 | - * @param string $template Template content to be parsed. |
|
| 778 | - * @param array $valid_shortcodes Valid shortcodes for the template being parsed. |
|
| 779 | - * @param array $extra_data Extra data that might be used when parsing the template. |
|
| 780 | - */ |
|
| 781 | - protected function _parse_question_list_for_primary_or_recipient_registration( |
|
| 782 | - $shortcode_parser, |
|
| 783 | - $questions, |
|
| 784 | - $answers, |
|
| 785 | - $template, |
|
| 786 | - $valid_shortcodes, |
|
| 787 | - $extra_data |
|
| 788 | - ) { |
|
| 789 | - $question_list = ''; |
|
| 790 | - /** @var EEH_Parse_Shortcodes $shortcode_helper */ |
|
| 791 | - $shortcode_helper = $shortcode_parser->get_shortcode_helper(); |
|
| 792 | - foreach ($answers as $answer) { |
|
| 793 | - if ($answer instanceof EE_Answer) { |
|
| 794 | - // first see if the question is in our $questions array. If not then try to get from answer object. |
|
| 795 | - $question = isset($questions[ $answer->ID() ]) ? $questions[ $answer->ID() ] : null; |
|
| 796 | - $question = ! $question instanceof EE_Question ? $answer->question() : $question; |
|
| 797 | - if (! $question instanceof EE_Question |
|
| 798 | - || ( |
|
| 799 | - $question instanceof EE_Question |
|
| 800 | - && $question->admin_only() |
|
| 801 | - ) |
|
| 802 | - ) { |
|
| 803 | - continue; |
|
| 804 | - } |
|
| 805 | - $question_list .= $shortcode_helper->parse_question_list_template( |
|
| 806 | - $template, |
|
| 807 | - $answer, |
|
| 808 | - $valid_shortcodes, |
|
| 809 | - $extra_data |
|
| 810 | - ); |
|
| 811 | - } |
|
| 812 | - } |
|
| 813 | - return $question_list; |
|
| 814 | - } |
|
| 16 | + /** |
|
| 17 | + * constructor. |
|
| 18 | + */ |
|
| 19 | + public function __construct() |
|
| 20 | + { |
|
| 21 | + $this->_caf_hooks(); |
|
| 22 | + } |
|
| 23 | + |
|
| 24 | + |
|
| 25 | + /** |
|
| 26 | + * Contains all the hooks filters for setting up caffeinated messages functionality. |
|
| 27 | + * |
|
| 28 | + * @since 4.3.2 |
|
| 29 | + * |
|
| 30 | + * @return void |
|
| 31 | + */ |
|
| 32 | + private function _caf_hooks() |
|
| 33 | + { |
|
| 34 | + add_filter('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', array($this, 'messages_autoload_paths'), 5); |
|
| 35 | + add_filter( |
|
| 36 | + 'FHEE__EE_Email_messenger__get_validator_config', |
|
| 37 | + array($this, 'email_messenger_validator_config'), |
|
| 38 | + 5, |
|
| 39 | + 2 |
|
| 40 | + ); |
|
| 41 | + add_filter( |
|
| 42 | + 'FHEE__EE_Email_messenger__get_template_fields', |
|
| 43 | + array($this, 'email_messenger_template_fields'), |
|
| 44 | + 5, |
|
| 45 | + 2 |
|
| 46 | + ); |
|
| 47 | + add_filter( |
|
| 48 | + 'FHEE__EE_Html_messenger__get_template_fields', |
|
| 49 | + array($this, 'html_messenger_template_fields'), |
|
| 50 | + 5, |
|
| 51 | + 2 |
|
| 52 | + ); |
|
| 53 | + add_filter( |
|
| 54 | + 'FHEE__EE_Html_messenger__get_validator_config', |
|
| 55 | + array($this, 'html_messenger_validator_config'), |
|
| 56 | + 5, |
|
| 57 | + 2 |
|
| 58 | + ); |
|
| 59 | + add_filter('FHEE__EE_Pdf_messenger__get_template_fields', array($this, 'pdf_messenger_template_fields'), 5, 2); |
|
| 60 | + add_filter( |
|
| 61 | + 'FHEE__EE_Pdf_messenger__get_validator_config', |
|
| 62 | + array($this, 'pdf_messenger_validator_config'), |
|
| 63 | + 5, |
|
| 64 | + 2 |
|
| 65 | + ); |
|
| 66 | + add_filter( |
|
| 67 | + 'FHEE__EE_Messages_Template_Pack__get_specific_template__contents', |
|
| 68 | + array($this, 'new_default_templates'), |
|
| 69 | + 5, |
|
| 70 | + 7 |
|
| 71 | + ); |
|
| 72 | + add_filter( |
|
| 73 | + 'FHEE__EE_Messages_Base__get_valid_shortcodes', |
|
| 74 | + array($this, 'message_types_valid_shortcodes'), |
|
| 75 | + 5, |
|
| 76 | + 2 |
|
| 77 | + ); |
|
| 78 | + |
|
| 79 | + // shortcode parsers |
|
| 80 | + add_filter('FHEE__EE_Attendee_Shortcodes__shortcodes', array($this, 'additional_attendee_shortcodes'), 5, 2); |
|
| 81 | + add_filter('FHEE__EE_Attendee_Shortcodes__parser_after', array($this, 'additional_attendee_parser'), 5, 5); |
|
| 82 | + add_filter( |
|
| 83 | + 'FHEE__EE_Recipient_List_Shortcodes__shortcodes', |
|
| 84 | + array($this, 'additional_recipient_details_shortcodes'), |
|
| 85 | + 5, |
|
| 86 | + 2 |
|
| 87 | + ); |
|
| 88 | + add_filter( |
|
| 89 | + 'FHEE__EE_Recipient_List_Shortcodes__parser_after', |
|
| 90 | + array($this, 'additional_recipient_details_parser'), |
|
| 91 | + 5, |
|
| 92 | + 5 |
|
| 93 | + ); |
|
| 94 | + add_filter( |
|
| 95 | + 'FHEE__EE_Primary_Registration_List_Shortcodes__shortcodes', |
|
| 96 | + array($this, 'additional_primary_registration_details_shortcodes'), |
|
| 97 | + 5, |
|
| 98 | + 2 |
|
| 99 | + ); |
|
| 100 | + add_filter( |
|
| 101 | + 'FHEE__EE_Primary_Registration_List_Shortcodes__parser_after', |
|
| 102 | + array($this, 'additional_primary_registration_details_parser'), |
|
| 103 | + 5, |
|
| 104 | + 5 |
|
| 105 | + ); |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * @since 4.2.0 |
|
| 109 | + */ |
|
| 110 | + add_filter('FHEE__EE_Datetime_Shortcodes__shortcodes', array($this, 'additional_datetime_shortcodes'), 10, 2); |
|
| 111 | + add_filter('FHEE__EE_Datetime_Shortcodes__parser_after', array($this, 'additional_datetime_parser'), 10, 5); |
|
| 112 | + |
|
| 113 | + /** |
|
| 114 | + * @since 4.3.0 |
|
| 115 | + */ |
|
| 116 | + // eat our own dog food! |
|
| 117 | + add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_message_types')); |
|
| 118 | + add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_shortcodes')); |
|
| 119 | + do_action('EE_Brewing_Regular___messages_caf'); |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + |
|
| 123 | + /** |
|
| 124 | + * This just allows us to add additional paths to the autoloader (EED_Messages::autoload_messages()) for the |
|
| 125 | + * messages system. |
|
| 126 | + * |
|
| 127 | + * @param array $dir_ref original array of paths |
|
| 128 | + * |
|
| 129 | + * @return array appended paths |
|
| 130 | + */ |
|
| 131 | + public function messages_autoload_paths($dir_ref) |
|
| 132 | + { |
|
| 133 | + $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/'; |
|
| 134 | + |
|
| 135 | + return $dir_ref; |
|
| 136 | + } |
|
| 137 | + |
|
| 138 | + |
|
| 139 | + public function email_messenger_validator_config($validator_config, EE_Email_messenger $messenger) |
|
| 140 | + { |
|
| 141 | + $validator_config['attendee_list'] = array( |
|
| 142 | + 'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'), |
|
| 143 | + 'required' => array('[ATTENDEE_LIST]'), |
|
| 144 | + ); |
|
| 145 | + $validator_config['question_list'] = array( |
|
| 146 | + 'shortcodes' => array('question'), |
|
| 147 | + 'required' => array('[QUESTION_LIST]'), |
|
| 148 | + ); |
|
| 149 | + |
|
| 150 | + return $validator_config; |
|
| 151 | + } |
|
| 152 | + |
|
| 153 | + |
|
| 154 | + public function html_messenger_validator_config($validator_config, EE_Html_messenger $messenger) |
|
| 155 | + { |
|
| 156 | + $validator_config['attendee_list'] = array( |
|
| 157 | + 'shortcodes' => array('attendee', 'question_list'), |
|
| 158 | + 'required' => array('[ATTENDEE_LIST]'), |
|
| 159 | + ); |
|
| 160 | + $validator_config['question_list'] = array( |
|
| 161 | + 'shortcodes' => array('question'), |
|
| 162 | + 'required' => array('[QUESTION_LIST]'), |
|
| 163 | + ); |
|
| 164 | + |
|
| 165 | + return $validator_config; |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + |
|
| 169 | + public function pdf_messenger_validator_config($validator_config, EE_Pdf_messenger $messenger) |
|
| 170 | + { |
|
| 171 | + $validator_config['attendee_list'] = array( |
|
| 172 | + 'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'), |
|
| 173 | + 'required' => array('[ATTENDEE_LIST]'), |
|
| 174 | + ); |
|
| 175 | + $validator_config['question_list'] = array( |
|
| 176 | + 'shortcodes' => array('question'), |
|
| 177 | + 'required' => array('[QUESTION_LIST]'), |
|
| 178 | + ); |
|
| 179 | + |
|
| 180 | + return $validator_config; |
|
| 181 | + } |
|
| 182 | + |
|
| 183 | + |
|
| 184 | + public function email_messenger_template_fields($template_fields, EE_Email_messenger $messenger) |
|
| 185 | + { |
|
| 186 | + $template_fields['extra']['content']['question_list'] = array( |
|
| 187 | + 'input' => 'textarea', |
|
| 188 | + 'label' => '[QUESTION_LIST]', |
|
| 189 | + 'type' => 'string', |
|
| 190 | + 'required' => true, |
|
| 191 | + 'validation' => true, |
|
| 192 | + 'format' => '%s', |
|
| 193 | + 'css_class' => 'large-text', |
|
| 194 | + 'rows' => '5', |
|
| 195 | + 'shortcodes_required' => array('[QUESTION_LIST]'), |
|
| 196 | + ); |
|
| 197 | + |
|
| 198 | + return $template_fields; |
|
| 199 | + } |
|
| 200 | + |
|
| 201 | + |
|
| 202 | + public function html_messenger_template_fields($template_fields, EE_Html_messenger $messenger) |
|
| 203 | + { |
|
| 204 | + $template_fields['extra']['content']['question_list'] = array( |
|
| 205 | + 'input' => 'textarea', |
|
| 206 | + 'label' => '[QUESTION_LIST]', |
|
| 207 | + 'type' => 'string', |
|
| 208 | + 'required' => true, |
|
| 209 | + 'validation' => true, |
|
| 210 | + 'format' => '%s', |
|
| 211 | + 'css_class' => 'large-text', |
|
| 212 | + 'rows' => '5', |
|
| 213 | + 'shortcodes_required' => array('[QUESTION_LIST]'), |
|
| 214 | + ); |
|
| 215 | + |
|
| 216 | + return $template_fields; |
|
| 217 | + } |
|
| 218 | + |
|
| 219 | + |
|
| 220 | + public function pdf_messenger_template_fields($template_fields, EE_Pdf_messenger $messenger) |
|
| 221 | + { |
|
| 222 | + $template_fields['extra']['content']['question_list'] = array( |
|
| 223 | + 'input' => 'textarea', |
|
| 224 | + 'label' => '[QUESTION_LIST]', |
|
| 225 | + 'type' => 'string', |
|
| 226 | + 'required' => true, |
|
| 227 | + 'validation' => true, |
|
| 228 | + 'format' => '%s', |
|
| 229 | + 'css_class' => 'large-text', |
|
| 230 | + 'rows' => '5', |
|
| 231 | + 'shortcodes_required' => array('[QUESTION_LIST]'), |
|
| 232 | + ); |
|
| 233 | + |
|
| 234 | + return $template_fields; |
|
| 235 | + } |
|
| 236 | + |
|
| 237 | + |
|
| 238 | + public function new_default_templates( |
|
| 239 | + $contents, |
|
| 240 | + $actual_path, |
|
| 241 | + EE_messenger $messenger, |
|
| 242 | + EE_message_type $message_type, |
|
| 243 | + $field, |
|
| 244 | + $context, |
|
| 245 | + EE_Messages_Template_Pack $template_pack |
|
| 246 | + ) { |
|
| 247 | + |
|
| 248 | + // we're only modifying templates for the default template pack |
|
| 249 | + if (! $template_pack instanceof EE_Messages_Template_Pack_Default) { |
|
| 250 | + return $contents; |
|
| 251 | + } |
|
| 252 | + |
|
| 253 | + // the template file name we're replacing contents for. |
|
| 254 | + $template_file_prefix = $field . '_' . $context; |
|
| 255 | + $msg_prefix = $messenger->name . '_' . $message_type->name . '_'; |
|
| 256 | + |
|
| 257 | + $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/'; |
|
| 258 | + |
|
| 259 | + if ($messenger->name == 'email' && $message_type->name == 'registration') { |
|
| 260 | + switch ($template_file_prefix) { |
|
| 261 | + case 'question_list_admin': |
|
| 262 | + case 'question_list_attendee': |
|
| 263 | + case 'question_list_primary_attendee': |
|
| 264 | + $path = $base_path . $msg_prefix . 'question_list.template.php'; |
|
| 265 | + $contents = EEH_Template::display_template($path, array(), true); |
|
| 266 | + break; |
|
| 267 | + |
|
| 268 | + case 'attendee_list_primary_attendee': |
|
| 269 | + $path = $base_path . $msg_prefix . 'attendee_list.template.php'; |
|
| 270 | + $contents = EEH_Template::display_template($path, array(), true); |
|
| 271 | + break; |
|
| 272 | + |
|
| 273 | + case 'attendee_list_admin': |
|
| 274 | + $path = $base_path . $msg_prefix . 'attendee_list_admin.template.php'; |
|
| 275 | + $contents = EEH_Template::display_template( |
|
| 276 | + $path, |
|
| 277 | + array(), |
|
| 278 | + true |
|
| 279 | + ); |
|
| 280 | + break; |
|
| 281 | + |
|
| 282 | + case 'attendee_list_attendee': |
|
| 283 | + $contents = ''; |
|
| 284 | + break; |
|
| 285 | + |
|
| 286 | + case 'event_list_attendee': |
|
| 287 | + $path = $base_path . $msg_prefix . 'event_list_attendee.template.php'; |
|
| 288 | + $contents = EEH_Template::display_template($path, array(), true); |
|
| 289 | + break; |
|
| 290 | + } |
|
| 291 | + } elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') { |
|
| 292 | + switch ($template_file_prefix) { |
|
| 293 | + case 'content_attendee': |
|
| 294 | + $path = $base_path . $msg_prefix . 'content.template.php'; |
|
| 295 | + $contents = EEH_Template::display_template($path, array(), true); |
|
| 296 | + break; |
|
| 297 | + |
|
| 298 | + case 'newsletter_content_attendee': |
|
| 299 | + $path = $base_path . $msg_prefix . 'newsletter_content.template.php'; |
|
| 300 | + $contents = EEH_Template::display_template($path, array(), true); |
|
| 301 | + break; |
|
| 302 | + |
|
| 303 | + case 'newsletter_subject_attendee': |
|
| 304 | + $path = $base_path . $msg_prefix . 'subject.template.php'; |
|
| 305 | + $contents = EEH_Template::display_template($path, array(), true); |
|
| 306 | + break; |
|
| 307 | + } |
|
| 308 | + } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') { |
|
| 309 | + switch ($template_file_prefix) { |
|
| 310 | + case 'attendee_list_purchaser': |
|
| 311 | + $path = $base_path . $msg_prefix . 'attendee_list.template.php'; |
|
| 312 | + $contents = EEH_Template::display_template($path, array(), true); |
|
| 313 | + break; |
|
| 314 | + } |
|
| 315 | + } |
|
| 316 | + |
|
| 317 | + return $contents; |
|
| 318 | + } |
|
| 319 | + |
|
| 320 | + |
|
| 321 | + public function message_types_valid_shortcodes($valid_shortcodes, EE_Messages_Base $msg) |
|
| 322 | + { |
|
| 323 | + // make sure question_list and question are ONLY added for the core message types. Any other message types will have to explicitly set question_list as a valid shortcode. |
|
| 324 | + $include_with = array( |
|
| 325 | + 'registration', |
|
| 326 | + 'cancelled_registration', |
|
| 327 | + 'declined_registration', |
|
| 328 | + 'not_approved_registration', |
|
| 329 | + 'payment_declined', |
|
| 330 | + 'payment_failed', |
|
| 331 | + 'payment_cancelled', |
|
| 332 | + 'payment', |
|
| 333 | + 'payment_reminder', |
|
| 334 | + 'pending_approval', |
|
| 335 | + 'registration_summary', |
|
| 336 | + 'invoice', |
|
| 337 | + 'receipt', |
|
| 338 | + ); |
|
| 339 | + if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) { |
|
| 340 | + $contexts = array_keys($msg->get_contexts()); |
|
| 341 | + foreach ($contexts as $context) { |
|
| 342 | + $valid_shortcodes[ $context ][] = 'question_list'; |
|
| 343 | + $valid_shortcodes[ $context ][] = 'question'; |
|
| 344 | + } |
|
| 345 | + } |
|
| 346 | + |
|
| 347 | + return $valid_shortcodes; |
|
| 348 | + } |
|
| 349 | + |
|
| 350 | + |
|
| 351 | + public function additional_attendee_shortcodes($shortcodes, $shortcode_parser) |
|
| 352 | + { |
|
| 353 | + $shortcodes['[ANSWER_*]'] = __( |
|
| 354 | + 'This is a special dynamic shortcode. Right after the "*", add the exact text of a existing question, and if there is an answer for that question for this registrant, that will take the place of this shortcode.', |
|
| 355 | + 'event_espresso' |
|
| 356 | + ); |
|
| 357 | + |
|
| 358 | + return $shortcodes; |
|
| 359 | + } |
|
| 360 | + |
|
| 361 | + |
|
| 362 | + public function additional_attendee_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser) |
|
| 363 | + { |
|
| 364 | + |
|
| 365 | + if (strpos($shortcode, '[ANSWER_*') === false |
|
| 366 | + || ! isset($extra_data['data']->questions) |
|
| 367 | + || ! isset($extra_data['data']->registrations) |
|
| 368 | + ) { |
|
| 369 | + return $parsed; |
|
| 370 | + } |
|
| 371 | + |
|
| 372 | + // let's get the question from the code. |
|
| 373 | + $shortcode = str_replace('[ANSWER_*', '', $shortcode); |
|
| 374 | + $shortcode = trim(str_replace(']', '', $shortcode)); |
|
| 375 | + |
|
| 376 | + $registration = $data instanceof EE_Registration ? $data : null; |
|
| 377 | + $registration = ! $registration instanceof EE_Registration && is_array( |
|
| 378 | + $extra_data |
|
| 379 | + ) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Registration ? $extra_data['data'] : $registration; |
|
| 380 | + |
|
| 381 | + $aee = $data instanceof EE_Messages_Addressee ? $data : null; |
|
| 382 | + $aee = ! $aee instanceof EE_Messages_Addressee && is_array( |
|
| 383 | + $extra_data |
|
| 384 | + ) && isset($extra_data['data']) ? $extra_data['data'] : $aee; |
|
| 385 | + |
|
| 386 | + if (! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) { |
|
| 387 | + return $parsed; |
|
| 388 | + } |
|
| 389 | + |
|
| 390 | + // now let's figure out which question has this text. |
|
| 391 | + foreach ($aee->questions as $ansid => $question) { |
|
| 392 | + if ($question instanceof EE_Question |
|
| 393 | + && trim($question->display_text()) == trim($shortcode) |
|
| 394 | + && isset($aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ]) |
|
| 395 | + ) { |
|
| 396 | + return $aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ]->get_pretty( |
|
| 397 | + 'ANS_value', |
|
| 398 | + 'no_wpautop' |
|
| 399 | + ); |
|
| 400 | + } |
|
| 401 | + } |
|
| 402 | + |
|
| 403 | + // nothing! |
|
| 404 | + return $parsed; |
|
| 405 | + } |
|
| 406 | + |
|
| 407 | + |
|
| 408 | + /** |
|
| 409 | + * Callback for additional shortcodes filter for adding additional datetime shortcodes. |
|
| 410 | + * |
|
| 411 | + * @since 4.2 |
|
| 412 | + * |
|
| 413 | + * @param array $shortcodes array of shortcodes and |
|
| 414 | + * descriptions |
|
| 415 | + * @param EE_Datetime_Shortcodes $shortcode_parser EE_Shortcodes object |
|
| 416 | + * |
|
| 417 | + * @return array array of shortcodes and |
|
| 418 | + * descriptions |
|
| 419 | + */ |
|
| 420 | + public function additional_datetime_shortcodes($shortcodes, $shortcode_parser) |
|
| 421 | + { |
|
| 422 | + $shortcodes['[DTT_NAME]'] = __( |
|
| 423 | + 'This will be parsed to the Title given for a Datetime', |
|
| 424 | + 'event_espresso' |
|
| 425 | + ); |
|
| 426 | + $shortcodes['[DTT_DESCRIPTION]'] = __( |
|
| 427 | + 'This will be parsed to the description for a Datetime', |
|
| 428 | + 'event_espresso' |
|
| 429 | + ); |
|
| 430 | + $shortcodes['[DTT_NAME_OR_DATES]'] = __( |
|
| 431 | + 'When parsed, if the Datetime has a name, it is used, otherwise a formatted string including the start date and end date will be used.', |
|
| 432 | + 'event_espresso' |
|
| 433 | + ); |
|
| 434 | + |
|
| 435 | + return $shortcodes; |
|
| 436 | + } |
|
| 437 | + |
|
| 438 | + |
|
| 439 | + /** |
|
| 440 | + * Callback for additional shortcodes parser filter used for adding parser for new |
|
| 441 | + * Datetime shortcodes |
|
| 442 | + * |
|
| 443 | + * @since 4.2 |
|
| 444 | + * |
|
| 445 | + * @param string $parsed The finished parsed string for the given shortcode. |
|
| 446 | + * @param string $shortcode The shortcode being parsed. |
|
| 447 | + * @param object $data The incoming data object for the Shortcode Parser. |
|
| 448 | + * @param object $extra_data The incoming extra date object for the Shortcode |
|
| 449 | + * Parser. |
|
| 450 | + * @param EE_Datetime_Shortcodes $shortcode_parser |
|
| 451 | + * |
|
| 452 | + * @return string The new parsed string. |
|
| 453 | + */ |
|
| 454 | + public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser) |
|
| 455 | + { |
|
| 456 | + |
|
| 457 | + if (! $data instanceof EE_Datetime) { |
|
| 458 | + return ''; // get out because we can only parse with the datetime object. |
|
| 459 | + } |
|
| 460 | + |
|
| 461 | + switch ($shortcode) { |
|
| 462 | + case '[DTT_NAME]': |
|
| 463 | + return $data->name(); |
|
| 464 | + break; |
|
| 465 | + case '[DTT_DESCRIPTION]': |
|
| 466 | + return $data->description(); |
|
| 467 | + break; |
|
| 468 | + case '[DTT_NAME_OR_DATES]': |
|
| 469 | + return $data->get_dtt_display_name(true); |
|
| 470 | + break; |
|
| 471 | + default: |
|
| 472 | + return $parsed; |
|
| 473 | + break; |
|
| 474 | + } |
|
| 475 | + } |
|
| 476 | + |
|
| 477 | + |
|
| 478 | + public function additional_recipient_details_shortcodes($shortcodes, $shortcode_parser) |
|
| 479 | + { |
|
| 480 | + $shortcodes['[RECIPIENT_QUESTION_LIST]'] = __( |
|
| 481 | + 'This is used to indicate where you want the list of questions and answers to show for the person receiving the message.', |
|
| 482 | + 'event_espresso' |
|
| 483 | + ); |
|
| 484 | + |
|
| 485 | + return $shortcodes; |
|
| 486 | + } |
|
| 487 | + |
|
| 488 | + |
|
| 489 | + /** |
|
| 490 | + * Callback for FHEE__EE_Recipient_List_Shortcodes__parser_after filter (dynamic filter). |
|
| 491 | + * |
|
| 492 | + * @param string $parsed The original parsed content for the shortcode |
|
| 493 | + * @param string $shortcode The shortcode being parsed |
|
| 494 | + * @param array $data The shortcode parser data array |
|
| 495 | + * @param array $extra_data The shortcode parser extra data array |
|
| 496 | + * @param \EE_Shortcodes $shortcode_parser Shortcode parser. |
|
| 497 | + * |
|
| 498 | + * @return string |
|
| 499 | + */ |
|
| 500 | + public function additional_recipient_details_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser) |
|
| 501 | + { |
|
| 502 | + |
|
| 503 | + if (array($data) && ! isset($data['data'])) { |
|
| 504 | + return $parsed; |
|
| 505 | + } |
|
| 506 | + |
|
| 507 | + $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null; |
|
| 508 | + $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient; |
|
| 509 | + |
|
| 510 | + if (! $recipient instanceof EE_Messages_Addressee) { |
|
| 511 | + return $parsed; |
|
| 512 | + } |
|
| 513 | + |
|
| 514 | + switch ($shortcode) { |
|
| 515 | + case '[RECIPIENT_QUESTION_LIST]': |
|
| 516 | + $att = $recipient->att_obj; |
|
| 517 | + $registrations_on_attendee = $att instanceof EE_Attendee |
|
| 518 | + ? $recipient->attendees[ $att->ID() ]['reg_objs'] |
|
| 519 | + : array(); |
|
| 520 | + $registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee; |
|
| 521 | + $answers = array(); |
|
| 522 | + |
|
| 523 | + $template = is_array($data['template']) && isset($data['template']['question_list']) |
|
| 524 | + ? $data['template']['question_list'] |
|
| 525 | + : $extra_data['template']['question_list']; |
|
| 526 | + $valid_shortcodes = array('question'); |
|
| 527 | + |
|
| 528 | + // if the context is main_content then get all answers for all registrations on this attendee |
|
| 529 | + if ($data['data'] instanceof EE_Messages_Addressee) { |
|
| 530 | + foreach ($registrations_on_attendee as $reg) { |
|
| 531 | + if ($reg instanceof EE_Registration) { |
|
| 532 | + $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs']) |
|
| 533 | + ? $recipient->registrations[ $reg->ID() ]['ans_objs'] |
|
| 534 | + : array(); |
|
| 535 | + foreach ($anss as $ans) { |
|
| 536 | + if ($ans instanceof EE_Answer) { |
|
| 537 | + $answers[ $ans->ID() ] = $ans; |
|
| 538 | + } |
|
| 539 | + } |
|
| 540 | + } |
|
| 541 | + } |
|
| 542 | + } |
|
| 543 | + |
|
| 544 | + // if the context is the event list parser, then let's return just the answers for all registrations attached to the recipient for that event. |
|
| 545 | + if ($data['data'] instanceof EE_Event) { |
|
| 546 | + $event = $data['data']; |
|
| 547 | + foreach ($registrations_on_attendee as $reg) { |
|
| 548 | + if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) { |
|
| 549 | + $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs']) |
|
| 550 | + ? $recipient->registrations[ $reg->ID() ]['ans_objs'] |
|
| 551 | + : array(); |
|
| 552 | + foreach ($anss as $ans) { |
|
| 553 | + if ($ans instanceof EE_Answer) { |
|
| 554 | + $answers[ $ans->ID() ] = $ans; |
|
| 555 | + } |
|
| 556 | + } |
|
| 557 | + } |
|
| 558 | + } |
|
| 559 | + } |
|
| 560 | + |
|
| 561 | + $questions = $questions = isset($recipient->questions) ? $recipient->questions : array(); |
|
| 562 | + |
|
| 563 | + // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee |
|
| 564 | + // object on it. |
|
| 565 | + if (! isset($extra_data['data'])) { |
|
| 566 | + $extra_data['data'] = $recipient; |
|
| 567 | + } |
|
| 568 | + |
|
| 569 | + return $this->_parse_question_list_for_primary_or_recipient_registration( |
|
| 570 | + $shortcode_parser, |
|
| 571 | + $questions, |
|
| 572 | + $answers, |
|
| 573 | + $template, |
|
| 574 | + $valid_shortcodes, |
|
| 575 | + $extra_data |
|
| 576 | + ); |
|
| 577 | + break; |
|
| 578 | + |
|
| 579 | + default: |
|
| 580 | + return $parsed; |
|
| 581 | + break; |
|
| 582 | + } |
|
| 583 | + } |
|
| 584 | + |
|
| 585 | + |
|
| 586 | + public function additional_primary_registration_details_shortcodes($shortcodes, $shortcode_parser) |
|
| 587 | + { |
|
| 588 | + $shortcodes['[PRIMARY_REGISTRANT_QUESTION_LIST]'] = __( |
|
| 589 | + 'This is used to indicate the questions and answers for the primary_registrant. It should be placed in the "[attendee_list]" field', |
|
| 590 | + 'event_espresso' |
|
| 591 | + ); |
|
| 592 | + |
|
| 593 | + return $shortcodes; |
|
| 594 | + } |
|
| 595 | + |
|
| 596 | + |
|
| 597 | + /** |
|
| 598 | + * Callback for FHEE__EE_Primary_Registration_List_Shortcodes__parser_after filter (dynamic filter). |
|
| 599 | + * |
|
| 600 | + * @param string $parsed The original parsed content for the shortcode |
|
| 601 | + * @param string $shortcode The shortcode being parsed |
|
| 602 | + * @param array $data The shortcode parser data array |
|
| 603 | + * @param array $extra_data The shortcode parser extra data array |
|
| 604 | + * @param \EE_Shortcodes $shortcode_parser Shortcode parser. |
|
| 605 | + * |
|
| 606 | + * @return string |
|
| 607 | + */ |
|
| 608 | + public function additional_primary_registration_details_parser( |
|
| 609 | + $parsed, |
|
| 610 | + $shortcode, |
|
| 611 | + $data, |
|
| 612 | + $extra_data, |
|
| 613 | + $shortcode_parser |
|
| 614 | + ) { |
|
| 615 | + if (array($data) && ! isset($data['data'])) { |
|
| 616 | + return $parsed; |
|
| 617 | + } |
|
| 618 | + |
|
| 619 | + $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null; |
|
| 620 | + $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient; |
|
| 621 | + |
|
| 622 | + if (! $recipient instanceof EE_Messages_Addressee) { |
|
| 623 | + return $parsed; |
|
| 624 | + } |
|
| 625 | + |
|
| 626 | + switch ($shortcode) { |
|
| 627 | + case '[PRIMARY_REGISTRANT_QUESTION_LIST]': |
|
| 628 | + if (! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) { |
|
| 629 | + return ''; |
|
| 630 | + } |
|
| 631 | + $registration = $recipient->primary_reg_obj; |
|
| 632 | + $answers = isset($recipient->registrations[ $registration->ID() ]['ans_objs']) |
|
| 633 | + ? $recipient->registrations[ $registration->ID() ]['ans_objs'] |
|
| 634 | + : array(); |
|
| 635 | + if (empty($answers)) { |
|
| 636 | + return ''; |
|
| 637 | + } |
|
| 638 | + $template = is_array($data['template']) && isset($data['template']['question_list']) |
|
| 639 | + ? $data['template']['question_list'] |
|
| 640 | + : $extra_data['template']['question_list']; |
|
| 641 | + $valid_shortcodes = array('question'); |
|
| 642 | + $answers = $recipient->registrations[ $registration->ID() ]['ans_objs']; |
|
| 643 | + $questions = isset($recipient->questions) ? $recipient->questions : array(); |
|
| 644 | + // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee |
|
| 645 | + // object on it. |
|
| 646 | + if (! isset($extra_data['data'])) { |
|
| 647 | + $extra_data['data'] = $recipient; |
|
| 648 | + } |
|
| 649 | + return $this->_parse_question_list_for_primary_or_recipient_registration( |
|
| 650 | + $shortcode_parser, |
|
| 651 | + $questions, |
|
| 652 | + $answers, |
|
| 653 | + $template, |
|
| 654 | + $valid_shortcodes, |
|
| 655 | + $extra_data |
|
| 656 | + ); |
|
| 657 | + break; |
|
| 658 | + |
|
| 659 | + default: |
|
| 660 | + return $parsed; |
|
| 661 | + break; |
|
| 662 | + } |
|
| 663 | + } |
|
| 664 | + |
|
| 665 | + |
|
| 666 | + /** |
|
| 667 | + * Takes care of registering the message types that are only available in caffeinated EE. |
|
| 668 | + * |
|
| 669 | + * @since 4.3.2 |
|
| 670 | + * |
|
| 671 | + * @return void |
|
| 672 | + */ |
|
| 673 | + public function register_caf_message_types() |
|
| 674 | + { |
|
| 675 | + // register newsletter message type |
|
| 676 | + $setup_args = array( |
|
| 677 | + 'mtfilename' => 'EE_Newsletter_message_type.class.php', |
|
| 678 | + 'autoloadpaths' => array( |
|
| 679 | + EE_CAF_LIBRARIES . 'messages/message_type/newsletter/', |
|
| 680 | + ), |
|
| 681 | + 'messengers_to_activate_with' => array('email'), |
|
| 682 | + 'messengers_to_validate_with' => array('email'), |
|
| 683 | + 'messengers_supporting_default_template_pack_with' => array('email'), |
|
| 684 | + ); |
|
| 685 | + EE_Register_Message_Type::register('newsletter', $setup_args); |
|
| 686 | + |
|
| 687 | + // register payment reminder message type |
|
| 688 | + $setup_args = array( |
|
| 689 | + 'mtfilename' => 'EE_Payment_Reminder_message_type.class.php', |
|
| 690 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'), |
|
| 691 | + 'messengers_to_activate_with' => array('email'), |
|
| 692 | + 'messengers_to_validate_with' => array('email'), |
|
| 693 | + 'messengers_supporting_default_template_pack_with' => array('email'), |
|
| 694 | + ); |
|
| 695 | + EE_Register_Message_Type::register('payment_reminder', $setup_args); |
|
| 696 | + |
|
| 697 | + // register payment declined message type |
|
| 698 | + $setup_args = array( |
|
| 699 | + 'mtfilename' => 'EE_Payment_Declined_message_type.class.php', |
|
| 700 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'), |
|
| 701 | + 'messengers_to_activate_with' => array('email'), |
|
| 702 | + 'messengers_to_validate_with' => array('email'), |
|
| 703 | + 'messengers_supporting_default_template_pack_with' => array('email'), |
|
| 704 | + ); |
|
| 705 | + EE_Register_Message_Type::register('payment_declined', $setup_args); |
|
| 706 | + |
|
| 707 | + // register registration declined message type |
|
| 708 | + $setup_args = array( |
|
| 709 | + 'mtfilename' => 'EE_Declined_Registration_message_type.class.php', |
|
| 710 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'), |
|
| 711 | + 'messengers_to_activate_with' => array('email'), |
|
| 712 | + 'messengers_to_validate_with' => array('email'), |
|
| 713 | + 'messengers_supporting_default_template_pack_with' => array('email'), |
|
| 714 | + ); |
|
| 715 | + EE_Register_Message_Type::register('declined_registration', $setup_args); |
|
| 716 | + |
|
| 717 | + // register registration cancelled message type |
|
| 718 | + $setup_args = array( |
|
| 719 | + 'mtfilename' => 'EE_Cancelled_Registration_message_type.class.php', |
|
| 720 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'), |
|
| 721 | + 'messengers_to_activate_with' => array('email'), |
|
| 722 | + 'messengers_to_validate_with' => array('email'), |
|
| 723 | + 'messengers_supporting_default_template_pack_with' => array('email'), |
|
| 724 | + ); |
|
| 725 | + EE_Register_Message_Type::register('cancelled_registration', $setup_args); |
|
| 726 | + |
|
| 727 | + |
|
| 728 | + // register payment failed message type |
|
| 729 | + $setup_args = array( |
|
| 730 | + 'mtfilename' => 'EE_Payment_Failed_message_type.class.php', |
|
| 731 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'), |
|
| 732 | + 'messengers_to_activate_with' => array('email'), |
|
| 733 | + 'messengers_to_validate_with' => array('email'), |
|
| 734 | + 'messengers_supporting_default_template_pack_with' => array('email'), |
|
| 735 | + ); |
|
| 736 | + EE_Register_Message_Type::register('payment_failed', $setup_args); |
|
| 737 | + |
|
| 738 | + // register payment declined message type |
|
| 739 | + $setup_args = array( |
|
| 740 | + 'mtfilename' => 'EE_Payment_Cancelled_message_type.class.php', |
|
| 741 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'), |
|
| 742 | + 'messengers_to_activate_with' => array('email'), |
|
| 743 | + 'messengers_to_validate_with' => array('email'), |
|
| 744 | + 'messengers_supporting_default_template_pack_with' => array('email'), |
|
| 745 | + ); |
|
| 746 | + EE_Register_Message_Type::register('payment_cancelled', $setup_args); |
|
| 747 | + } |
|
| 748 | + |
|
| 749 | + |
|
| 750 | + /** |
|
| 751 | + * Takes care of registering the shortcode libraries implemented with caffeinated EE and set up related items. |
|
| 752 | + * |
|
| 753 | + * @since 4.3.2 |
|
| 754 | + * |
|
| 755 | + * @return void |
|
| 756 | + */ |
|
| 757 | + public function register_caf_shortcodes() |
|
| 758 | + { |
|
| 759 | + $setup_args = array( |
|
| 760 | + 'autoloadpaths' => array( |
|
| 761 | + EE_CAF_LIBRARIES . 'shortcodes/', |
|
| 762 | + ), |
|
| 763 | + 'msgr_validator_callback' => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'), |
|
| 764 | + 'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'), |
|
| 765 | + 'list_type_shortcodes' => array('[NEWSLETTER_CONTENT]'), |
|
| 766 | + ); |
|
| 767 | + EE_Register_Messages_Shortcode_Library::register('newsletter', $setup_args); |
|
| 768 | + } |
|
| 769 | + |
|
| 770 | + |
|
| 771 | + /** |
|
| 772 | + * Parses a question list shortcode using given data and template |
|
| 773 | + * |
|
| 774 | + * @param \EE_Shortcodes $shortcode_parser |
|
| 775 | + * @param EE_Question[] $questions An array of questions indexed by answer id. |
|
| 776 | + * @param EE_Answer[] $answers An array of answer objects |
|
| 777 | + * @param string $template Template content to be parsed. |
|
| 778 | + * @param array $valid_shortcodes Valid shortcodes for the template being parsed. |
|
| 779 | + * @param array $extra_data Extra data that might be used when parsing the template. |
|
| 780 | + */ |
|
| 781 | + protected function _parse_question_list_for_primary_or_recipient_registration( |
|
| 782 | + $shortcode_parser, |
|
| 783 | + $questions, |
|
| 784 | + $answers, |
|
| 785 | + $template, |
|
| 786 | + $valid_shortcodes, |
|
| 787 | + $extra_data |
|
| 788 | + ) { |
|
| 789 | + $question_list = ''; |
|
| 790 | + /** @var EEH_Parse_Shortcodes $shortcode_helper */ |
|
| 791 | + $shortcode_helper = $shortcode_parser->get_shortcode_helper(); |
|
| 792 | + foreach ($answers as $answer) { |
|
| 793 | + if ($answer instanceof EE_Answer) { |
|
| 794 | + // first see if the question is in our $questions array. If not then try to get from answer object. |
|
| 795 | + $question = isset($questions[ $answer->ID() ]) ? $questions[ $answer->ID() ] : null; |
|
| 796 | + $question = ! $question instanceof EE_Question ? $answer->question() : $question; |
|
| 797 | + if (! $question instanceof EE_Question |
|
| 798 | + || ( |
|
| 799 | + $question instanceof EE_Question |
|
| 800 | + && $question->admin_only() |
|
| 801 | + ) |
|
| 802 | + ) { |
|
| 803 | + continue; |
|
| 804 | + } |
|
| 805 | + $question_list .= $shortcode_helper->parse_question_list_template( |
|
| 806 | + $template, |
|
| 807 | + $answer, |
|
| 808 | + $valid_shortcodes, |
|
| 809 | + $extra_data |
|
| 810 | + ); |
|
| 811 | + } |
|
| 812 | + } |
|
| 813 | + return $question_list; |
|
| 814 | + } |
|
| 815 | 815 | } |
@@ -130,7 +130,7 @@ discard block |
||
| 130 | 130 | */ |
| 131 | 131 | public function messages_autoload_paths($dir_ref) |
| 132 | 132 | { |
| 133 | - $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/'; |
|
| 133 | + $dir_ref[] = EE_CAF_LIBRARIES.'shortcodes/'; |
|
| 134 | 134 | |
| 135 | 135 | return $dir_ref; |
| 136 | 136 | } |
@@ -246,32 +246,32 @@ discard block |
||
| 246 | 246 | ) { |
| 247 | 247 | |
| 248 | 248 | // we're only modifying templates for the default template pack |
| 249 | - if (! $template_pack instanceof EE_Messages_Template_Pack_Default) { |
|
| 249 | + if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default) { |
|
| 250 | 250 | return $contents; |
| 251 | 251 | } |
| 252 | 252 | |
| 253 | 253 | // the template file name we're replacing contents for. |
| 254 | - $template_file_prefix = $field . '_' . $context; |
|
| 255 | - $msg_prefix = $messenger->name . '_' . $message_type->name . '_'; |
|
| 254 | + $template_file_prefix = $field.'_'.$context; |
|
| 255 | + $msg_prefix = $messenger->name.'_'.$message_type->name.'_'; |
|
| 256 | 256 | |
| 257 | - $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/'; |
|
| 257 | + $base_path = EE_CAF_LIBRARIES.'messages/defaults/default/'; |
|
| 258 | 258 | |
| 259 | 259 | if ($messenger->name == 'email' && $message_type->name == 'registration') { |
| 260 | 260 | switch ($template_file_prefix) { |
| 261 | 261 | case 'question_list_admin': |
| 262 | 262 | case 'question_list_attendee': |
| 263 | 263 | case 'question_list_primary_attendee': |
| 264 | - $path = $base_path . $msg_prefix . 'question_list.template.php'; |
|
| 264 | + $path = $base_path.$msg_prefix.'question_list.template.php'; |
|
| 265 | 265 | $contents = EEH_Template::display_template($path, array(), true); |
| 266 | 266 | break; |
| 267 | 267 | |
| 268 | 268 | case 'attendee_list_primary_attendee': |
| 269 | - $path = $base_path . $msg_prefix . 'attendee_list.template.php'; |
|
| 269 | + $path = $base_path.$msg_prefix.'attendee_list.template.php'; |
|
| 270 | 270 | $contents = EEH_Template::display_template($path, array(), true); |
| 271 | 271 | break; |
| 272 | 272 | |
| 273 | 273 | case 'attendee_list_admin': |
| 274 | - $path = $base_path . $msg_prefix . 'attendee_list_admin.template.php'; |
|
| 274 | + $path = $base_path.$msg_prefix.'attendee_list_admin.template.php'; |
|
| 275 | 275 | $contents = EEH_Template::display_template( |
| 276 | 276 | $path, |
| 277 | 277 | array(), |
@@ -284,31 +284,31 @@ discard block |
||
| 284 | 284 | break; |
| 285 | 285 | |
| 286 | 286 | case 'event_list_attendee': |
| 287 | - $path = $base_path . $msg_prefix . 'event_list_attendee.template.php'; |
|
| 287 | + $path = $base_path.$msg_prefix.'event_list_attendee.template.php'; |
|
| 288 | 288 | $contents = EEH_Template::display_template($path, array(), true); |
| 289 | 289 | break; |
| 290 | 290 | } |
| 291 | 291 | } elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') { |
| 292 | 292 | switch ($template_file_prefix) { |
| 293 | 293 | case 'content_attendee': |
| 294 | - $path = $base_path . $msg_prefix . 'content.template.php'; |
|
| 294 | + $path = $base_path.$msg_prefix.'content.template.php'; |
|
| 295 | 295 | $contents = EEH_Template::display_template($path, array(), true); |
| 296 | 296 | break; |
| 297 | 297 | |
| 298 | 298 | case 'newsletter_content_attendee': |
| 299 | - $path = $base_path . $msg_prefix . 'newsletter_content.template.php'; |
|
| 299 | + $path = $base_path.$msg_prefix.'newsletter_content.template.php'; |
|
| 300 | 300 | $contents = EEH_Template::display_template($path, array(), true); |
| 301 | 301 | break; |
| 302 | 302 | |
| 303 | 303 | case 'newsletter_subject_attendee': |
| 304 | - $path = $base_path . $msg_prefix . 'subject.template.php'; |
|
| 304 | + $path = $base_path.$msg_prefix.'subject.template.php'; |
|
| 305 | 305 | $contents = EEH_Template::display_template($path, array(), true); |
| 306 | 306 | break; |
| 307 | 307 | } |
| 308 | 308 | } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') { |
| 309 | 309 | switch ($template_file_prefix) { |
| 310 | 310 | case 'attendee_list_purchaser': |
| 311 | - $path = $base_path . $msg_prefix . 'attendee_list.template.php'; |
|
| 311 | + $path = $base_path.$msg_prefix.'attendee_list.template.php'; |
|
| 312 | 312 | $contents = EEH_Template::display_template($path, array(), true); |
| 313 | 313 | break; |
| 314 | 314 | } |
@@ -339,8 +339,8 @@ discard block |
||
| 339 | 339 | if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) { |
| 340 | 340 | $contexts = array_keys($msg->get_contexts()); |
| 341 | 341 | foreach ($contexts as $context) { |
| 342 | - $valid_shortcodes[ $context ][] = 'question_list'; |
|
| 343 | - $valid_shortcodes[ $context ][] = 'question'; |
|
| 342 | + $valid_shortcodes[$context][] = 'question_list'; |
|
| 343 | + $valid_shortcodes[$context][] = 'question'; |
|
| 344 | 344 | } |
| 345 | 345 | } |
| 346 | 346 | |
@@ -383,7 +383,7 @@ discard block |
||
| 383 | 383 | $extra_data |
| 384 | 384 | ) && isset($extra_data['data']) ? $extra_data['data'] : $aee; |
| 385 | 385 | |
| 386 | - if (! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) { |
|
| 386 | + if ( ! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) { |
|
| 387 | 387 | return $parsed; |
| 388 | 388 | } |
| 389 | 389 | |
@@ -391,9 +391,9 @@ discard block |
||
| 391 | 391 | foreach ($aee->questions as $ansid => $question) { |
| 392 | 392 | if ($question instanceof EE_Question |
| 393 | 393 | && trim($question->display_text()) == trim($shortcode) |
| 394 | - && isset($aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ]) |
|
| 394 | + && isset($aee->registrations[$registration->ID()]['ans_objs'][$ansid]) |
|
| 395 | 395 | ) { |
| 396 | - return $aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ]->get_pretty( |
|
| 396 | + return $aee->registrations[$registration->ID()]['ans_objs'][$ansid]->get_pretty( |
|
| 397 | 397 | 'ANS_value', |
| 398 | 398 | 'no_wpautop' |
| 399 | 399 | ); |
@@ -454,7 +454,7 @@ discard block |
||
| 454 | 454 | public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser) |
| 455 | 455 | { |
| 456 | 456 | |
| 457 | - if (! $data instanceof EE_Datetime) { |
|
| 457 | + if ( ! $data instanceof EE_Datetime) { |
|
| 458 | 458 | return ''; // get out because we can only parse with the datetime object. |
| 459 | 459 | } |
| 460 | 460 | |
@@ -507,7 +507,7 @@ discard block |
||
| 507 | 507 | $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null; |
| 508 | 508 | $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient; |
| 509 | 509 | |
| 510 | - if (! $recipient instanceof EE_Messages_Addressee) { |
|
| 510 | + if ( ! $recipient instanceof EE_Messages_Addressee) { |
|
| 511 | 511 | return $parsed; |
| 512 | 512 | } |
| 513 | 513 | |
@@ -515,7 +515,7 @@ discard block |
||
| 515 | 515 | case '[RECIPIENT_QUESTION_LIST]': |
| 516 | 516 | $att = $recipient->att_obj; |
| 517 | 517 | $registrations_on_attendee = $att instanceof EE_Attendee |
| 518 | - ? $recipient->attendees[ $att->ID() ]['reg_objs'] |
|
| 518 | + ? $recipient->attendees[$att->ID()]['reg_objs'] |
|
| 519 | 519 | : array(); |
| 520 | 520 | $registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee; |
| 521 | 521 | $answers = array(); |
@@ -529,12 +529,12 @@ discard block |
||
| 529 | 529 | if ($data['data'] instanceof EE_Messages_Addressee) { |
| 530 | 530 | foreach ($registrations_on_attendee as $reg) { |
| 531 | 531 | if ($reg instanceof EE_Registration) { |
| 532 | - $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs']) |
|
| 533 | - ? $recipient->registrations[ $reg->ID() ]['ans_objs'] |
|
| 532 | + $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs']) |
|
| 533 | + ? $recipient->registrations[$reg->ID()]['ans_objs'] |
|
| 534 | 534 | : array(); |
| 535 | 535 | foreach ($anss as $ans) { |
| 536 | 536 | if ($ans instanceof EE_Answer) { |
| 537 | - $answers[ $ans->ID() ] = $ans; |
|
| 537 | + $answers[$ans->ID()] = $ans; |
|
| 538 | 538 | } |
| 539 | 539 | } |
| 540 | 540 | } |
@@ -546,12 +546,12 @@ discard block |
||
| 546 | 546 | $event = $data['data']; |
| 547 | 547 | foreach ($registrations_on_attendee as $reg) { |
| 548 | 548 | if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) { |
| 549 | - $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs']) |
|
| 550 | - ? $recipient->registrations[ $reg->ID() ]['ans_objs'] |
|
| 549 | + $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs']) |
|
| 550 | + ? $recipient->registrations[$reg->ID()]['ans_objs'] |
|
| 551 | 551 | : array(); |
| 552 | 552 | foreach ($anss as $ans) { |
| 553 | 553 | if ($ans instanceof EE_Answer) { |
| 554 | - $answers[ $ans->ID() ] = $ans; |
|
| 554 | + $answers[$ans->ID()] = $ans; |
|
| 555 | 555 | } |
| 556 | 556 | } |
| 557 | 557 | } |
@@ -562,7 +562,7 @@ discard block |
||
| 562 | 562 | |
| 563 | 563 | // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee |
| 564 | 564 | // object on it. |
| 565 | - if (! isset($extra_data['data'])) { |
|
| 565 | + if ( ! isset($extra_data['data'])) { |
|
| 566 | 566 | $extra_data['data'] = $recipient; |
| 567 | 567 | } |
| 568 | 568 | |
@@ -619,18 +619,18 @@ discard block |
||
| 619 | 619 | $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null; |
| 620 | 620 | $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient; |
| 621 | 621 | |
| 622 | - if (! $recipient instanceof EE_Messages_Addressee) { |
|
| 622 | + if ( ! $recipient instanceof EE_Messages_Addressee) { |
|
| 623 | 623 | return $parsed; |
| 624 | 624 | } |
| 625 | 625 | |
| 626 | 626 | switch ($shortcode) { |
| 627 | 627 | case '[PRIMARY_REGISTRANT_QUESTION_LIST]': |
| 628 | - if (! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) { |
|
| 628 | + if ( ! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) { |
|
| 629 | 629 | return ''; |
| 630 | 630 | } |
| 631 | 631 | $registration = $recipient->primary_reg_obj; |
| 632 | - $answers = isset($recipient->registrations[ $registration->ID() ]['ans_objs']) |
|
| 633 | - ? $recipient->registrations[ $registration->ID() ]['ans_objs'] |
|
| 632 | + $answers = isset($recipient->registrations[$registration->ID()]['ans_objs']) |
|
| 633 | + ? $recipient->registrations[$registration->ID()]['ans_objs'] |
|
| 634 | 634 | : array(); |
| 635 | 635 | if (empty($answers)) { |
| 636 | 636 | return ''; |
@@ -639,11 +639,11 @@ discard block |
||
| 639 | 639 | ? $data['template']['question_list'] |
| 640 | 640 | : $extra_data['template']['question_list']; |
| 641 | 641 | $valid_shortcodes = array('question'); |
| 642 | - $answers = $recipient->registrations[ $registration->ID() ]['ans_objs']; |
|
| 642 | + $answers = $recipient->registrations[$registration->ID()]['ans_objs']; |
|
| 643 | 643 | $questions = isset($recipient->questions) ? $recipient->questions : array(); |
| 644 | 644 | // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee |
| 645 | 645 | // object on it. |
| 646 | - if (! isset($extra_data['data'])) { |
|
| 646 | + if ( ! isset($extra_data['data'])) { |
|
| 647 | 647 | $extra_data['data'] = $recipient; |
| 648 | 648 | } |
| 649 | 649 | return $this->_parse_question_list_for_primary_or_recipient_registration( |
@@ -676,7 +676,7 @@ discard block |
||
| 676 | 676 | $setup_args = array( |
| 677 | 677 | 'mtfilename' => 'EE_Newsletter_message_type.class.php', |
| 678 | 678 | 'autoloadpaths' => array( |
| 679 | - EE_CAF_LIBRARIES . 'messages/message_type/newsletter/', |
|
| 679 | + EE_CAF_LIBRARIES.'messages/message_type/newsletter/', |
|
| 680 | 680 | ), |
| 681 | 681 | 'messengers_to_activate_with' => array('email'), |
| 682 | 682 | 'messengers_to_validate_with' => array('email'), |
@@ -687,7 +687,7 @@ discard block |
||
| 687 | 687 | // register payment reminder message type |
| 688 | 688 | $setup_args = array( |
| 689 | 689 | 'mtfilename' => 'EE_Payment_Reminder_message_type.class.php', |
| 690 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'), |
|
| 690 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES.'messages/message_type/payment_reminder/'), |
|
| 691 | 691 | 'messengers_to_activate_with' => array('email'), |
| 692 | 692 | 'messengers_to_validate_with' => array('email'), |
| 693 | 693 | 'messengers_supporting_default_template_pack_with' => array('email'), |
@@ -697,7 +697,7 @@ discard block |
||
| 697 | 697 | // register payment declined message type |
| 698 | 698 | $setup_args = array( |
| 699 | 699 | 'mtfilename' => 'EE_Payment_Declined_message_type.class.php', |
| 700 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'), |
|
| 700 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES.'messages/message_type/payment_declined/'), |
|
| 701 | 701 | 'messengers_to_activate_with' => array('email'), |
| 702 | 702 | 'messengers_to_validate_with' => array('email'), |
| 703 | 703 | 'messengers_supporting_default_template_pack_with' => array('email'), |
@@ -707,7 +707,7 @@ discard block |
||
| 707 | 707 | // register registration declined message type |
| 708 | 708 | $setup_args = array( |
| 709 | 709 | 'mtfilename' => 'EE_Declined_Registration_message_type.class.php', |
| 710 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'), |
|
| 710 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES.'messages/message_type/declined_registration/'), |
|
| 711 | 711 | 'messengers_to_activate_with' => array('email'), |
| 712 | 712 | 'messengers_to_validate_with' => array('email'), |
| 713 | 713 | 'messengers_supporting_default_template_pack_with' => array('email'), |
@@ -717,7 +717,7 @@ discard block |
||
| 717 | 717 | // register registration cancelled message type |
| 718 | 718 | $setup_args = array( |
| 719 | 719 | 'mtfilename' => 'EE_Cancelled_Registration_message_type.class.php', |
| 720 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'), |
|
| 720 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES.'messages/message_type/cancelled_registration/'), |
|
| 721 | 721 | 'messengers_to_activate_with' => array('email'), |
| 722 | 722 | 'messengers_to_validate_with' => array('email'), |
| 723 | 723 | 'messengers_supporting_default_template_pack_with' => array('email'), |
@@ -728,7 +728,7 @@ discard block |
||
| 728 | 728 | // register payment failed message type |
| 729 | 729 | $setup_args = array( |
| 730 | 730 | 'mtfilename' => 'EE_Payment_Failed_message_type.class.php', |
| 731 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'), |
|
| 731 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES.'messages/message_type/payment_failed/'), |
|
| 732 | 732 | 'messengers_to_activate_with' => array('email'), |
| 733 | 733 | 'messengers_to_validate_with' => array('email'), |
| 734 | 734 | 'messengers_supporting_default_template_pack_with' => array('email'), |
@@ -738,7 +738,7 @@ discard block |
||
| 738 | 738 | // register payment declined message type |
| 739 | 739 | $setup_args = array( |
| 740 | 740 | 'mtfilename' => 'EE_Payment_Cancelled_message_type.class.php', |
| 741 | - 'autoloadpaths' => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'), |
|
| 741 | + 'autoloadpaths' => array(EE_CAF_LIBRARIES.'messages/message_type/payment_cancelled/'), |
|
| 742 | 742 | 'messengers_to_activate_with' => array('email'), |
| 743 | 743 | 'messengers_to_validate_with' => array('email'), |
| 744 | 744 | 'messengers_supporting_default_template_pack_with' => array('email'), |
@@ -758,7 +758,7 @@ discard block |
||
| 758 | 758 | { |
| 759 | 759 | $setup_args = array( |
| 760 | 760 | 'autoloadpaths' => array( |
| 761 | - EE_CAF_LIBRARIES . 'shortcodes/', |
|
| 761 | + EE_CAF_LIBRARIES.'shortcodes/', |
|
| 762 | 762 | ), |
| 763 | 763 | 'msgr_validator_callback' => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'), |
| 764 | 764 | 'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'), |
@@ -792,9 +792,9 @@ discard block |
||
| 792 | 792 | foreach ($answers as $answer) { |
| 793 | 793 | if ($answer instanceof EE_Answer) { |
| 794 | 794 | // first see if the question is in our $questions array. If not then try to get from answer object. |
| 795 | - $question = isset($questions[ $answer->ID() ]) ? $questions[ $answer->ID() ] : null; |
|
| 795 | + $question = isset($questions[$answer->ID()]) ? $questions[$answer->ID()] : null; |
|
| 796 | 796 | $question = ! $question instanceof EE_Question ? $answer->question() : $question; |
| 797 | - if (! $question instanceof EE_Question |
|
| 797 | + if ( ! $question instanceof EE_Question |
|
| 798 | 798 | || ( |
| 799 | 799 | $question instanceof EE_Question |
| 800 | 800 | && $question->admin_only() |
