eventespresso / event-espresso-core

admin_pages/maintenance/templates/ee_system_stati_page.template.php

Indentation +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
  */
 function ee_recurse_into_array_for_display($data) {
 	if (is_object($data) || $data instanceof __PHP_Incomplete_Class) {//is_object($incomplete_class) actually returns false, hence why we check for it
-        $data = json_decode(json_encode($data), true);
+		$data = json_decode(json_encode($data), true);
 	}
 	if (is_array($data)) {
 		if (EEH_Array::is_associative_array($data)) {

Spacing +5 added lines, -5 removed lines

@@ -23,10 +23,10 @@ 
 						?>
 						<tr>
 							<td>
-								<?php echo $data_key;?>
+								<?php echo $data_key; ?>
 							</td>
 							<td>
-								<?php ee_recurse_into_array_for_display($data_values);?>
+								<?php ee_recurse_into_array_for_display($data_values); ?>
 							</td>
 						</tr>
 						<?php
@@ -40,19 +40,19 @@ 
 			<ul>
 				<?php
 				foreach ($data as $datum) {
-					echo "<li>";ee_recurse_into_array_for_display($datum);echo "</li>";
+					echo "<li>"; ee_recurse_into_array_for_display($datum); echo "</li>";
 				}?>
 			</ul>
 			<?php
 		}
-	}else {
+	} else {
 		//simple value
 		echo $data;
 	}
 }
 ?>
 <h1>
-	<?php _e("System Information", "event_espresso");?> <a href="<?php echo $download_system_status_url;?>" class="button-secondary"><?php esc_html_e( 'Download to File', 'event_espresso' );?></a>
+	<?php _e("System Information", "event_espresso"); ?> <a href="<?php echo $download_system_status_url; ?>" class="button-secondary"><?php esc_html_e('Download to File', 'event_espresso'); ?></a>
 </h1>
 <div class="padding">
 

core/domain/entities/shortcodes/EspressoCheckout.php

Indentation +53 added lines, -53 removed lines

@@ -21,59 +21,59 @@
 {
 
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_CHECKOUT';
-    }
-
-
-
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return 0;
-    }
-
-
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    public function initializeShortcode()
-    {
-        global $wp_query;
-        EED_Single_Page_Checkout::init($wp_query);
-        $this->shortcodeHasBeenInitialized();
-    }
-
-
-
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     */
-    public function processShortcode($attributes = array())
-    {
-        return EE_Registry::instance()->REQ->get_output();
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_CHECKOUT';
+	}
+
+
+
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return 0;
+	}
+
+
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function initializeShortcode()
+	{
+		global $wp_query;
+		EED_Single_Page_Checkout::init($wp_query);
+		$this->shortcodeHasBeenInitialized();
+	}
+
+
+
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 */
+	public function processShortcode($attributes = array())
+	{
+		return EE_Registry::instance()->REQ->get_output();
+	}
 
 
 

core/domain/entities/shortcodes/EspressoTxnPage.php

Indentation +86 added lines, -86 removed lines

@@ -27,92 +27,92 @@
 
 
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_TXN_PAGE';
-    }
-
-
-
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return 0;
-    }
-
-
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     * @throws \Exception
-     * @throws \EE_Error
-     */
-    public function initializeShortcode()
-    {
-        $transaction = null;
-        if (EE_Registry::instance()->REQ->is_set('e_reg_url_link')) {
-            /** @var EEM_Transaction $EEM_Transaction */
-            $EEM_Transaction = EE_Registry::instance()->load_model('Transaction');
-            $transaction = $EEM_Transaction->get_transaction_from_reg_url_link();
-        }
-        if ($transaction instanceof EE_Transaction) {
-            $payment_method = null;
-            $payment_method_slug = EE_Registry::instance()->REQ->get('ee_payment_method', null);
-            if ($payment_method_slug) {
-                $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($payment_method_slug);
-            }
-            if ($payment_method instanceof EE_Payment_Method && $payment_method->is_off_site()) {
-                $gateway = $payment_method->type_obj()->get_gateway();
-                if (
-                    $gateway instanceof EE_Offsite_Gateway
-                    && $gateway->handle_IPN_in_this_request(
-                        \EE_Registry::instance()->REQ->params(),
-                        true
-                    )
-                ) {
-                    /** @type EE_Payment_Processor $payment_processor */
-                    $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-                    $payment_processor->process_ipn($_REQUEST, $transaction, $payment_method);
-                }
-            }
-            //allow gateways to add a filter to stop rendering the page
-            if (apply_filters('FHEE__EES_Espresso_Txn_Page__run__exit', false)) {
-                exit;
-            }
-        }
-        $this->shortcodeHasBeenInitialized();
-    }
-
-
-
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     */
-    public function processShortcode($attributes = array())
-    {
-        return esc_html__(
-            'This is the Event Espresso Transactions page. This page receives instant payment notification (IPN) requests and should have a status of published, but should not be easily accessible by site visitors. Do not add it to your website\'s navigation menu or link to it from another page. Also, do not delete it or change its status to private.',
-            'event_espresso'
-        );
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_TXN_PAGE';
+	}
+
+
+
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return 0;
+	}
+
+
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 * @throws \Exception
+	 * @throws \EE_Error
+	 */
+	public function initializeShortcode()
+	{
+		$transaction = null;
+		if (EE_Registry::instance()->REQ->is_set('e_reg_url_link')) {
+			/** @var EEM_Transaction $EEM_Transaction */
+			$EEM_Transaction = EE_Registry::instance()->load_model('Transaction');
+			$transaction = $EEM_Transaction->get_transaction_from_reg_url_link();
+		}
+		if ($transaction instanceof EE_Transaction) {
+			$payment_method = null;
+			$payment_method_slug = EE_Registry::instance()->REQ->get('ee_payment_method', null);
+			if ($payment_method_slug) {
+				$payment_method = EEM_Payment_Method::instance()->get_one_by_slug($payment_method_slug);
+			}
+			if ($payment_method instanceof EE_Payment_Method && $payment_method->is_off_site()) {
+				$gateway = $payment_method->type_obj()->get_gateway();
+				if (
+					$gateway instanceof EE_Offsite_Gateway
+					&& $gateway->handle_IPN_in_this_request(
+						\EE_Registry::instance()->REQ->params(),
+						true
+					)
+				) {
+					/** @type EE_Payment_Processor $payment_processor */
+					$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+					$payment_processor->process_ipn($_REQUEST, $transaction, $payment_method);
+				}
+			}
+			//allow gateways to add a filter to stop rendering the page
+			if (apply_filters('FHEE__EES_Espresso_Txn_Page__run__exit', false)) {
+				exit;
+			}
+		}
+		$this->shortcodeHasBeenInitialized();
+	}
+
+
+
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 */
+	public function processShortcode($attributes = array())
+	{
+		return esc_html__(
+			'This is the Event Espresso Transactions page. This page receives instant payment notification (IPN) requests and should have a status of published, but should not be easily accessible by site visitors. Do not add it to your website\'s navigation menu or link to it from another page. Also, do not delete it or change its status to private.',
+			'event_espresso'
+		);
+	}
 }
 // End of file EspressoTxnPage.php
 // Location: EventEspresso\core\domain\entities\shortcodes/EspressoTxnPage.php
\ No newline at end of file

core/domain/entities/shortcodes/EspressoThankYou.php

Indentation +69 added lines, -69 removed lines

@@ -20,75 +20,75 @@
 class EspressoThankYou extends EspressoShortcode
 {
 
-    /**
-     * @var boolean $is_thank_you_page
-     */
-    private $is_thank_you_page = false;
-
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_THANK_YOU';
-    }
-
-
-
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return 0;
-    }
-
-
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    public function initializeShortcode()
-    {
-        global $wp_query;
-        if (empty($wp_query->posts) || count($wp_query->posts) > 1) {
-            return;
-        }
-        $post = reset($wp_query->posts);
-        if ( ! $post instanceof WP_Post || $post->ID !== EE_Registry::instance()->CFG->core->thank_you_page_id ) {
-            return;
-        }
-        $this->is_thank_you_page = true;
-        \EED_Thank_You_Page::instance()->load_resources();
-        $this->shortcodeHasBeenInitialized();
-    }
-
-
-
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     * @throws \EE_Error
-     */
-    public function processShortcode($attributes = array())
-    {
-        return $this->is_thank_you_page
-            ? \EED_Thank_You_Page::instance()->thank_you_page_results()
-            : '';
-    }
+	/**
+	 * @var boolean $is_thank_you_page
+	 */
+	private $is_thank_you_page = false;
+
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_THANK_YOU';
+	}
+
+
+
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return 0;
+	}
+
+
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function initializeShortcode()
+	{
+		global $wp_query;
+		if (empty($wp_query->posts) || count($wp_query->posts) > 1) {
+			return;
+		}
+		$post = reset($wp_query->posts);
+		if ( ! $post instanceof WP_Post || $post->ID !== EE_Registry::instance()->CFG->core->thank_you_page_id ) {
+			return;
+		}
+		$this->is_thank_you_page = true;
+		\EED_Thank_You_Page::instance()->load_resources();
+		$this->shortcodeHasBeenInitialized();
+	}
+
+
+
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function processShortcode($attributes = array())
+	{
+		return $this->is_thank_you_page
+			? \EED_Thank_You_Page::instance()->thank_you_page_results()
+			: '';
+	}
 
 
 

core/domain/entities/shortcodes/EspressoEvents.php

Indentation +128 added lines, -128 removed lines

@@ -34,134 +34,134 @@
 
 
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_EVENTS';
-    }
-
-
-
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return MINUTE_IN_SECONDS * 15;
-    }
-
-
-
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     */
-    public function initializeShortcode()
-    {
-        EED_Events_Archive::instance()->event_list();
-        $this->shortcodeHasBeenInitialized();
-    }
-
-
-
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     */
-    public function processShortcode($attributes = array())
-    {
-        // grab attributes and merge with defaults
-        $attributes = $this->getAttributes($attributes);
-        // make sure we use the_excerpt()
-        add_filter('FHEE__EES_Espresso_Events__process_shortcode__true', '__return_true');
-        // apply query filters
-        add_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true');
-        // run the query
-        global $wp_query;
-        // yes we have to overwrite the main wp query, but it's ok...
-        // we're going to reset it again below, so everything will be Hunky Dory (amazing album)
-        $wp_query = new EventListQuery($attributes);
-        // check what template is loaded and load filters accordingly
-        EED_Events_Archive::instance()->template_include('loop-espresso_events.php');
-        // load our template
-        $event_list = EEH_Template::locate_template('loop-espresso_events.php', array(), true, true);
-        // now reset the query and postdata
-        wp_reset_query();
-        wp_reset_postdata();
-        EED_Events_Archive::remove_all_events_archive_filters();
-        // remove query filters
-        remove_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true');
-        // pull our content from the output buffer and return it
-        return $event_list;
-    }
-
-
-
-    /**
-     * merge incoming attributes with filtered defaults
-     *
-     * @param array $attributes
-     * @return array
-     */
-    private function getAttributes(array $attributes)
-    {
-        return array_merge(
-            (array)apply_filters(
-                'EES_Espresso_Events__process_shortcode__default_espresso_events_shortcode_atts',
-                array(
-                    'title'         => '',
-                    'limit'         => 10,
-                    'css_class'     => '',
-                    'show_expired'  => false,
-                    'month'         => '',
-                    'category_slug' => '',
-                    'order_by'      => 'start_date',
-                    'sort'          => 'ASC',
-                    'show_title'    => true,
-                )
-            ),
-            $attributes
-        );
-    }
-
-
-
-    /**
-     * array for defining custom attribute sanitization callbacks,
-     * where keys match keys in your attributes array,
-     * and values represent the sanitization function you wish to be applied to that attribute.
-     * So for example, if you had an integer attribute named "event_id"
-     * that you wanted to be sanitized using absint(),
-     * then you would pass the following for your $custom_sanitization array:
-     *      array('event_id' => 'absint')
-     *
-     * @return array
-     */
-    protected function customAttributeSanitizationMap()
-    {
-        // the following get sanitized/whitelisted in EEH_Event_Query
-        return array(
-            'category_slug' => 'skip_sanitization',
-            'show_expired'  => 'skip_sanitization',
-            'order_by'      => 'skip_sanitization',
-            'month'         => 'skip_sanitization',
-            'sort'          => 'skip_sanitization',
-        );
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_EVENTS';
+	}
+
+
+
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return MINUTE_IN_SECONDS * 15;
+	}
+
+
+
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode()
+	{
+		EED_Events_Archive::instance()->event_list();
+		$this->shortcodeHasBeenInitialized();
+	}
+
+
+
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 */
+	public function processShortcode($attributes = array())
+	{
+		// grab attributes and merge with defaults
+		$attributes = $this->getAttributes($attributes);
+		// make sure we use the_excerpt()
+		add_filter('FHEE__EES_Espresso_Events__process_shortcode__true', '__return_true');
+		// apply query filters
+		add_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true');
+		// run the query
+		global $wp_query;
+		// yes we have to overwrite the main wp query, but it's ok...
+		// we're going to reset it again below, so everything will be Hunky Dory (amazing album)
+		$wp_query = new EventListQuery($attributes);
+		// check what template is loaded and load filters accordingly
+		EED_Events_Archive::instance()->template_include('loop-espresso_events.php');
+		// load our template
+		$event_list = EEH_Template::locate_template('loop-espresso_events.php', array(), true, true);
+		// now reset the query and postdata
+		wp_reset_query();
+		wp_reset_postdata();
+		EED_Events_Archive::remove_all_events_archive_filters();
+		// remove query filters
+		remove_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true');
+		// pull our content from the output buffer and return it
+		return $event_list;
+	}
+
+
+
+	/**
+	 * merge incoming attributes with filtered defaults
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function getAttributes(array $attributes)
+	{
+		return array_merge(
+			(array)apply_filters(
+				'EES_Espresso_Events__process_shortcode__default_espresso_events_shortcode_atts',
+				array(
+					'title'         => '',
+					'limit'         => 10,
+					'css_class'     => '',
+					'show_expired'  => false,
+					'month'         => '',
+					'category_slug' => '',
+					'order_by'      => 'start_date',
+					'sort'          => 'ASC',
+					'show_title'    => true,
+				)
+			),
+			$attributes
+		);
+	}
+
+
+
+	/**
+	 * array for defining custom attribute sanitization callbacks,
+	 * where keys match keys in your attributes array,
+	 * and values represent the sanitization function you wish to be applied to that attribute.
+	 * So for example, if you had an integer attribute named "event_id"
+	 * that you wanted to be sanitized using absint(),
+	 * then you would pass the following for your $custom_sanitization array:
+	 *      array('event_id' => 'absint')
+	 *
+	 * @return array
+	 */
+	protected function customAttributeSanitizationMap()
+	{
+		// the following get sanitized/whitelisted in EEH_Event_Query
+		return array(
+			'category_slug' => 'skip_sanitization',
+			'show_expired'  => 'skip_sanitization',
+			'order_by'      => 'skip_sanitization',
+			'month'         => 'skip_sanitization',
+			'sort'          => 'skip_sanitization',
+		);
+	}
 
 
 

core/domain/entities/shortcodes/EspressoCancelled.php

Indentation +73 added lines, -73 removed lines

@@ -24,79 +24,79 @@
 
 
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_CANCELLED';
-    }
-
-
-
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return 0;
-    }
-
-
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     */
-    public function initializeShortcode()
-    {
-        $this->shortcodeHasBeenInitialized();
-    }
-
-
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     * @throws \EE_Error
-     */
-    public function processShortcode($attributes = array())
-    {
-        $transaction = EE_Registry::instance()->SSN->get_session_data('transaction');
-        if ($transaction instanceof EE_Transaction) {
-            do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__transaction', $transaction);
-            $registrations = $transaction->registrations();
-            foreach ($registrations as $registration) {
-                if ($registration instanceof EE_Registration) {
-                    do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__registration', $registration);
-                }
-            }
-        }
-        do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__clear_session');
-        // remove all unwanted records from the db
-        if (EE_Registry::instance()->CART instanceof EE_Cart) {
-            EE_Registry::instance()->CART->delete_cart();
-        }
-        EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
-        return sprintf(
-            __(
-                '%sAll unsaved registration information entered during this session has been deleted.%s',
-                'event_espresso'
-            ),
-            '<p class="ee-registrations-cancelled-pg ee-attention">',
-            '</p>'
-        );
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_CANCELLED';
+	}
+
+
+
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return 0;
+	}
+
+
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode()
+	{
+		$this->shortcodeHasBeenInitialized();
+	}
+
+
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function processShortcode($attributes = array())
+	{
+		$transaction = EE_Registry::instance()->SSN->get_session_data('transaction');
+		if ($transaction instanceof EE_Transaction) {
+			do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__transaction', $transaction);
+			$registrations = $transaction->registrations();
+			foreach ($registrations as $registration) {
+				if ($registration instanceof EE_Registration) {
+					do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__registration', $registration);
+				}
+			}
+		}
+		do_action('AHEE__EES_Espresso_Cancelled__process_shortcode__clear_session');
+		// remove all unwanted records from the db
+		if (EE_Registry::instance()->CART instanceof EE_Cart) {
+			EE_Registry::instance()->CART->delete_cart();
+		}
+		EE_Registry::instance()->SSN->clear_session(__CLASS__, __FUNCTION__);
+		return sprintf(
+			__(
+				'%sAll unsaved registration information entered during this session has been deleted.%s',
+				'event_espresso'
+			),
+			'<p class="ee-registrations-cancelled-pg ee-attention">',
+			'</p>'
+		);
+	}
 
 }
 // End of file EspressoCancelled.php

core/domain/entities/shortcodes/EspressoEventAttendees.php

Indentation +239 added lines, -239 removed lines

@@ -28,245 +28,245 @@
 class EspressoEventAttendees extends EspressoShortcode
 {
 
-    private $query_params = array(
-        0 => array()
-    );
-
-    private $template_args = array(
-        'contacts'      => array(),
-        'event'         => null,
-        'datetime'      => null,
-        'ticket'        => null,
-    );
-
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_EVENT_ATTENDEES';
-    }
-
-
-
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return HOUR_IN_SECONDS;
-    }
-
-
-
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     */
-    public function initializeShortcode()
-    {
-        $this->shortcodeHasBeenInitialized();
-    }
-
-
-
-    /**
-     * process_shortcode - ESPRESSO_EVENT_ATTENDEES - Returns a list of attendees to an event.
-     *  [ESPRESSO_EVENT_ATTENDEES] - defaults to attendees for earliest active event, or earliest upcoming event.
-     *  [ESPRESSO_EVENT_ATTENDEES event_id=123] - attendees for specific event.
-     *  [ESPRESSO_EVENT_ATTENDEES datetime_id=245] - attendees for a specific datetime.
-     *  [ESPRESSO_EVENT_ATTENDEES ticket_id=123] - attendees for a specific ticket.
-     *  [ESPRESSO_EVENT_ATTENDEES status=all] - specific registration status (use status id) or all for all attendees
-     *                                          regardless of status.  Note default is to only return approved attendees
-     *  [ESPRESSO_EVENT_ATTENDEES show_gravatar=true] - default is to not return gravatar.  Otherwise if this is set
-     *                                                  then return gravatar for email address given.
-     *  Note: because of the relationship between event_id, ticket_id, and datetime_id.
-     * If more than one of those params is included then preference is given to the following:
-     *  - event_id is used whenever its present and any others are ignored.
-     *  - if no event_id then datetime is used whenever its present and any others are ignored.
-     *  - otherwise ticket_id is used if present.
-     *
-     * @param array $attributes
-     * @return string
-     * @throws \EE_Error
-     */
-    public function processShortcode($attributes = array())
-    {
-        // grab attributes and merge with defaults
-        $attributes = $this->getAttributes((array)$attributes);
-        // add attributes to template args
-        $this->template_args['show_gravatar'] = $attributes['show_gravatar'];
-        // add required objects: event, datetime, and ticket
-        $this->template_args['event'] = $this->getEventAndQueryParams($attributes);
-        $this->template_args['datetime'] = $this->getDatetimeAndQueryParams($attributes);
-        $this->template_args['ticket'] = $this->getTicketAndQueryParams($attributes);
-
-        // if any of the above objects is invalid or missing,
-        // then there was an invalid parameter or the shortcode was used incorrectly
-        // so when WP_DEBUG is set and true, we'll show a message,
-        // otherwise we'll just return an empty string.
-         if (
-            ! $this->template_args['event'] instanceof EE_Event
-            || empty($this->query_params[0])
-            || ($attributes['datetime_id'] && ! $this->template_args['datetime'] instanceof EE_Datetime)
-            || ($attributes['ticket_id'] && ! $this->template_args['ticket'] instanceof EE_Ticket)
-        ) {
-            if (WP_DEBUG) {
-                return '<div class="important-notice ee-attention">'
-                       . esc_html__('The [ESPRESSO_EVENT_ATTENDEES] shortcode has been used incorrectly.  Please double check the arguments you used for any typos.  In the case of ID type arguments, its possible the given ID does not correspond to existing data in the database.',
-                        'event_espresso')
-                       . '</div>';
-            } else {
-                return '';
-            }
-        }
-        $this->setAdditionalQueryParams($attributes);
-        //get contacts!
-        $this->template_args['contacts'] = EEM_Attendee::instance()->get_all($this->query_params);
-        //all set let's load up the template and return.
-        return EEH_Template::locate_template('loop-espresso_event_attendees.php', $this->template_args, true, true);
-    }
-
-
-
-    /**
-     * merge incoming attributes with filtered defaults
-     *
-     * @param array $attributes
-     * @return array
-     */
-    private function getAttributes(array $attributes)
-    {
-        return array_merge(
-            (array) apply_filters(
-                'EES_Espresso_Event_Attendees__process_shortcode__default_shortcode_atts',
-                array(
-                    'event_id'      => null,
-                    'datetime_id'   => null,
-                    'ticket_id'     => null,
-                    'status'        => EEM_Registration::status_id_approved,
-                    'show_gravatar' => false
-                )
-            ),
-            $attributes
-        );
-    }
-
-
-
-    /**
-     * @param array $attributes
-     * @return EE_Event|null
-     * @throws \EE_Error
-     */
-    private function getEventAndQueryParams(array $attributes){
-        if ( ! empty($attributes['event_id'])) {
-            $event = EEM_Event::instance()->get_one_by_ID($attributes['event_id']);
-            if ($event instanceof EE_Event) {
-                $this->query_params[0]['Registration.EVT_ID'] = $attributes['event_id'];
-                return $event;
-            }
-        }
-        //seems like is_espresso_event_single() isn't working as expected. So using alternate method.
-        if (is_single() && is_espresso_event()) {
-            $event = EEH_Event_View::get_event();
-            if ($event instanceof EE_Event) {
-                $this->query_params[0]['Registration.EVT_ID'] = $event->ID();
-                return $event;
-            }
-        }
-        // one last shot...
-        // try getting the earliest active event
-        $events = EEM_Event::instance()->get_active_events(array(
-            'limit'    => 1,
-            'order_by' => array('Datetime.DTT_EVT_start' => 'ASC')
-        ));
-        //  if none then get the next upcoming
-        $events = empty($events)
-            ? EEM_Event::instance()->get_upcoming_events(array(
-                'limit'    => 1,
-                'order_by' => array('Datetime.DTT_EVT_start' => 'ASC')
-            ))
-            : $events;
-        $event = reset($events);
-        if ($event instanceof EE_Event) {
-            $this->query_params[0]['Registration.EVT_ID'] = $event->ID();
-            return $event;
-        }
-        return null;
-    }
-
-
-
-    /**
-     * @param array $attributes
-     * @return EE_Datetime|null
-     */
-    private function getDatetimeAndQueryParams(array $attributes)
-    {
-        if ( ! empty($attributes['datetime_id'])) {
-            $datetime = EEM_Datetime::instance()->get_one_by_ID($attributes['datetime_id']);
-            if ($datetime instanceof EE_Datetime) {
-                $this->query_params[0]['Registration.Ticket.Datetime.DTT_ID'] = $attributes['datetime_id'];
-                $this->query_params['default_where_conditions'] = 'this_model_only';
-                if ( ! $this->template_args['event'] instanceof EE_Event) {
-                    $this->template_args['event'] = $datetime->event();
-                }
-                return $datetime;
-            }
-        }
-        return null;
-    }
-
-
-
-    /**
-     * @param array $attributes
-     * @return \EE_Base_Class|null
-     * @throws \EE_Error
-     */
-    private function getTicketAndQueryParams(array $attributes)
-    {
-        if ( ! empty($attributes['ticket_id']) && empty($attributes['event_id']) && empty($attributes['datetime_id'])) {
-            $ticket = EEM_Ticket::instance()->get_one_by_ID($attributes['ticket_id']);
-            if ($ticket instanceof EE_Ticket) {
-                $this->query_params[0]['Registration.TKT_ID'] = $attributes['ticket_id'];
-                if ( ! $this->template_args['event'] instanceof EE_Event) {
-                    $this->template_args['event'] = $ticket->first_datetime() instanceof EE_Datetime
-                        ? $ticket->first_datetime()->event()
-                        : null;
-                }
-                return $ticket;
-            }
-        }
-        return null;
-    }
-
-
-
-    /**
-     * @param array $attributes
-     */
-    private function setAdditionalQueryParams(array $attributes)
-    {
-        $reg_status_array = EEM_Registration::reg_status_array();
-        if ($attributes['status'] !== 'all' && isset($reg_status_array[$attributes['status']])) {
-            $this->query_params[0]['Registration.STS_ID'] = $attributes['status'];
-        }
-        $this->query_params['group_by'] = array('ATT_ID');
-        $this->query_params['order_by'] = (array) apply_filters(
-            'FHEE__EES_Espresso_Event_Attendees__process_shortcode__order_by',
-            array('ATT_lname' => 'ASC', 'ATT_fname' => 'ASC')
-        );
-    }
+	private $query_params = array(
+		0 => array()
+	);
+
+	private $template_args = array(
+		'contacts'      => array(),
+		'event'         => null,
+		'datetime'      => null,
+		'ticket'        => null,
+	);
+
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_EVENT_ATTENDEES';
+	}
+
+
+
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return HOUR_IN_SECONDS;
+	}
+
+
+
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode()
+	{
+		$this->shortcodeHasBeenInitialized();
+	}
+
+
+
+	/**
+	 * process_shortcode - ESPRESSO_EVENT_ATTENDEES - Returns a list of attendees to an event.
+	 *  [ESPRESSO_EVENT_ATTENDEES] - defaults to attendees for earliest active event, or earliest upcoming event.
+	 *  [ESPRESSO_EVENT_ATTENDEES event_id=123] - attendees for specific event.
+	 *  [ESPRESSO_EVENT_ATTENDEES datetime_id=245] - attendees for a specific datetime.
+	 *  [ESPRESSO_EVENT_ATTENDEES ticket_id=123] - attendees for a specific ticket.
+	 *  [ESPRESSO_EVENT_ATTENDEES status=all] - specific registration status (use status id) or all for all attendees
+	 *                                          regardless of status.  Note default is to only return approved attendees
+	 *  [ESPRESSO_EVENT_ATTENDEES show_gravatar=true] - default is to not return gravatar.  Otherwise if this is set
+	 *                                                  then return gravatar for email address given.
+	 *  Note: because of the relationship between event_id, ticket_id, and datetime_id.
+	 * If more than one of those params is included then preference is given to the following:
+	 *  - event_id is used whenever its present and any others are ignored.
+	 *  - if no event_id then datetime is used whenever its present and any others are ignored.
+	 *  - otherwise ticket_id is used if present.
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function processShortcode($attributes = array())
+	{
+		// grab attributes and merge with defaults
+		$attributes = $this->getAttributes((array)$attributes);
+		// add attributes to template args
+		$this->template_args['show_gravatar'] = $attributes['show_gravatar'];
+		// add required objects: event, datetime, and ticket
+		$this->template_args['event'] = $this->getEventAndQueryParams($attributes);
+		$this->template_args['datetime'] = $this->getDatetimeAndQueryParams($attributes);
+		$this->template_args['ticket'] = $this->getTicketAndQueryParams($attributes);
+
+		// if any of the above objects is invalid or missing,
+		// then there was an invalid parameter or the shortcode was used incorrectly
+		// so when WP_DEBUG is set and true, we'll show a message,
+		// otherwise we'll just return an empty string.
+		 if (
+			! $this->template_args['event'] instanceof EE_Event
+			|| empty($this->query_params[0])
+			|| ($attributes['datetime_id'] && ! $this->template_args['datetime'] instanceof EE_Datetime)
+			|| ($attributes['ticket_id'] && ! $this->template_args['ticket'] instanceof EE_Ticket)
+		) {
+			if (WP_DEBUG) {
+				return '<div class="important-notice ee-attention">'
+					   . esc_html__('The [ESPRESSO_EVENT_ATTENDEES] shortcode has been used incorrectly.  Please double check the arguments you used for any typos.  In the case of ID type arguments, its possible the given ID does not correspond to existing data in the database.',
+						'event_espresso')
+					   . '</div>';
+			} else {
+				return '';
+			}
+		}
+		$this->setAdditionalQueryParams($attributes);
+		//get contacts!
+		$this->template_args['contacts'] = EEM_Attendee::instance()->get_all($this->query_params);
+		//all set let's load up the template and return.
+		return EEH_Template::locate_template('loop-espresso_event_attendees.php', $this->template_args, true, true);
+	}
+
+
+
+	/**
+	 * merge incoming attributes with filtered defaults
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function getAttributes(array $attributes)
+	{
+		return array_merge(
+			(array) apply_filters(
+				'EES_Espresso_Event_Attendees__process_shortcode__default_shortcode_atts',
+				array(
+					'event_id'      => null,
+					'datetime_id'   => null,
+					'ticket_id'     => null,
+					'status'        => EEM_Registration::status_id_approved,
+					'show_gravatar' => false
+				)
+			),
+			$attributes
+		);
+	}
+
+
+
+	/**
+	 * @param array $attributes
+	 * @return EE_Event|null
+	 * @throws \EE_Error
+	 */
+	private function getEventAndQueryParams(array $attributes){
+		if ( ! empty($attributes['event_id'])) {
+			$event = EEM_Event::instance()->get_one_by_ID($attributes['event_id']);
+			if ($event instanceof EE_Event) {
+				$this->query_params[0]['Registration.EVT_ID'] = $attributes['event_id'];
+				return $event;
+			}
+		}
+		//seems like is_espresso_event_single() isn't working as expected. So using alternate method.
+		if (is_single() && is_espresso_event()) {
+			$event = EEH_Event_View::get_event();
+			if ($event instanceof EE_Event) {
+				$this->query_params[0]['Registration.EVT_ID'] = $event->ID();
+				return $event;
+			}
+		}
+		// one last shot...
+		// try getting the earliest active event
+		$events = EEM_Event::instance()->get_active_events(array(
+			'limit'    => 1,
+			'order_by' => array('Datetime.DTT_EVT_start' => 'ASC')
+		));
+		//  if none then get the next upcoming
+		$events = empty($events)
+			? EEM_Event::instance()->get_upcoming_events(array(
+				'limit'    => 1,
+				'order_by' => array('Datetime.DTT_EVT_start' => 'ASC')
+			))
+			: $events;
+		$event = reset($events);
+		if ($event instanceof EE_Event) {
+			$this->query_params[0]['Registration.EVT_ID'] = $event->ID();
+			return $event;
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * @param array $attributes
+	 * @return EE_Datetime|null
+	 */
+	private function getDatetimeAndQueryParams(array $attributes)
+	{
+		if ( ! empty($attributes['datetime_id'])) {
+			$datetime = EEM_Datetime::instance()->get_one_by_ID($attributes['datetime_id']);
+			if ($datetime instanceof EE_Datetime) {
+				$this->query_params[0]['Registration.Ticket.Datetime.DTT_ID'] = $attributes['datetime_id'];
+				$this->query_params['default_where_conditions'] = 'this_model_only';
+				if ( ! $this->template_args['event'] instanceof EE_Event) {
+					$this->template_args['event'] = $datetime->event();
+				}
+				return $datetime;
+			}
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * @param array $attributes
+	 * @return \EE_Base_Class|null
+	 * @throws \EE_Error
+	 */
+	private function getTicketAndQueryParams(array $attributes)
+	{
+		if ( ! empty($attributes['ticket_id']) && empty($attributes['event_id']) && empty($attributes['datetime_id'])) {
+			$ticket = EEM_Ticket::instance()->get_one_by_ID($attributes['ticket_id']);
+			if ($ticket instanceof EE_Ticket) {
+				$this->query_params[0]['Registration.TKT_ID'] = $attributes['ticket_id'];
+				if ( ! $this->template_args['event'] instanceof EE_Event) {
+					$this->template_args['event'] = $ticket->first_datetime() instanceof EE_Datetime
+						? $ticket->first_datetime()->event()
+						: null;
+				}
+				return $ticket;
+			}
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * @param array $attributes
+	 */
+	private function setAdditionalQueryParams(array $attributes)
+	{
+		$reg_status_array = EEM_Registration::reg_status_array();
+		if ($attributes['status'] !== 'all' && isset($reg_status_array[$attributes['status']])) {
+			$this->query_params[0]['Registration.STS_ID'] = $attributes['status'];
+		}
+		$this->query_params['group_by'] = array('ATT_ID');
+		$this->query_params['order_by'] = (array) apply_filters(
+			'FHEE__EES_Espresso_Event_Attendees__process_shortcode__order_by',
+			array('ATT_lname' => 'ASC', 'ATT_fname' => 'ASC')
+		);
+	}
 
 
 

core/services/shortcodes/ShortcodeInterface.php

Indentation +38 added lines, -38 removed lines

@@ -8,44 +8,44 @@
 interface ShortcodeInterface
 {
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag();
-
-    /**
-     * the length of time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration();
-
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * !!! IMPORTANT !!!
-     * After performing any logic within this method required for initialization
-     *         $this->shortcodeHasBeenInitialized();
-     * should be called to ensure that the shortcode is setup correctly.
-     *
-     * @return void
-     */
-    public function initializeShortcode();
-
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     */
-    public function processShortcode($attributes = array());
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag();
+
+	/**
+	 * the length of time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration();
+
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * !!! IMPORTANT !!!
+	 * After performing any logic within this method required for initialization
+	 *         $this->shortcodeHasBeenInitialized();
+	 * should be called to ensure that the shortcode is setup correctly.
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode();
+
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 */
+	public function processShortcode($attributes = array());
 
 }
 // End of file ShortcodeInterface.php

core/services/shortcodes/EspressoShortcode.php

Indentation +213 added lines, -213 removed lines

@@ -20,219 +20,219 @@
 abstract class EspressoShortcode implements ShortcodeInterface
 {
 
-    /**
-     * transient prefix
-     *
-     * @type string
-     */
-    const CACHE_TRANSIENT_PREFIX = 'ee_sc_';
-
-    /**
-     * @var PostRelatedCacheManager $cache_manager
-     */
-    private $cache_manager;
-
-    /**
-     * true if ShortcodeInterface::initializeShortcode() has been called
-     * if false, then that will get called before processing
-     *
-     * @var boolean $initialized
-     */
-    private $initialized = false;
-
-
-
-    /**
-     * EspressoShortcode constructor
-     *
-     * @param PostRelatedCacheManager $cache_manager
-     */
-    public function __construct(PostRelatedCacheManager $cache_manager)
-    {
-        $this->cache_manager = $cache_manager;
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public function shortcodeHasBeenInitialized()
-    {
-        $this->initialized = true;
-    }
-
-
-
-    /**
-     * enqueues scripts then processes the shortcode
-     *
-     * @param array $attributes
-     * @return string
-     * @throws \EE_Error
-     */
-    final public function processShortcodeCallback($attributes = array())
-    {
-        if ($this instanceof EnqueueAssetsInterface) {
-            if (is_admin()) {
-                $this->enqueueAdminScripts();
-            } else {
-                $this->enqueueScripts();
-            }
-        }
-        return $this->shortcodeContent(
-            $this->sanitizeAttributes((array)$attributes)
-        );
-    }
-
-
-
-    /**
-     * If shortcode caching is enabled for the shortcode,
-     * and cached results exist, then that will be returned
-     * else new content will be generated.
-     * If caching is enabled, then the new content will be cached for later.
-     *
-     * @param array $attributes
-     * @return mixed|string
-     * @throws \EE_Error
-     */
-    private function shortcodeContent(array $attributes)
-    {
-        $shortcode = $this;
-        $post_ID = $this->currentPostID();
-        // something like "SC_EVENTS-123"
-        $cache_ID = $this->shortcodeCacheID($post_ID);
-        $this->cache_manager->clearPostRelatedCacheOnUpdate($post_ID, $cache_ID);
-        return $this->cache_manager->get(
-            $cache_ID,
-            // serialized attributes
-            wp_json_encode($attributes),
-            // Closure for generating content if cache is expired
-            function () use ($shortcode, $attributes) {
-                if($shortcode->initialized === false){
-                    $shortcode->initializeShortcode();
-                }
-                return $shortcode->processShortcode($attributes);
-            },
-            // filterable cache expiration set by each shortcode
-            apply_filters(
-                'FHEE__EventEspresso_core_services_shortcodes_EspressoShortcode__shortcodeContent__cache_expiration',
-                $this->cacheExpiration(),
-                $this->getTag(),
-                $this
-            )
-        );
-    }
-
-
-
-    /**
-     * @return int
-     * @throws \EE_Error
-     */
-    private function currentPostID()
-    {
-        // try to get EE_Event any way we can
-        $event = EEH_Event_View::get_event();
-        // then get some kind of ID
-        if ($event instanceof \EE_Event) {
-            $post_ID = $event->ID();
-        } else {
-            global $post;
-            $post_ID = $post->ID;
-        }
-        return $post_ID;
-    }
-
-
-
-    /**
-     * @param int $post_ID
-     * @return string
-     * @throws \EE_Error
-     */
-    private function shortcodeCacheID($post_ID)
-    {
-        $tag = str_replace('ESPRESSO_', '', $this->getTag());
-        return "SC_{$tag}-{$post_ID}";
-    }
-
-
-
-    /**
-     * array for defining custom attribute sanitization callbacks,
-     * where keys match keys in your attributes array,
-     * and values represent the sanitization function you wish to be applied to that attribute.
-     * So for example, if you had an integer attribute named "event_id"
-     * that you wanted to be sanitized using absint(),
-     * then you would return the following:
-     *      array('event_id' => 'absint')
-     * Entering 'skip_sanitization' for the callback value
-     * means that no sanitization will be applied
-     * on the assumption that the attribute
-     * will be sanitized at some point... right?
-     * You wouldn't pass around unsanitized attributes would you?
-     * That would be very Tom Foolery of you!!!
-     *
-     * @return array
-     */
-    protected function customAttributeSanitizationMap()
-    {
-        return array();
-    }
-
-
-
-    /**
-     * Performs basic sanitization on shortcode attributes
-     * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
-     * most attributes will by default be sanitized using the sanitize_text_field() function.
-     * This can be overridden using the customAttributeSanitizationMap() method (see above),
-     * all other attributes would be sanitized using the defaults in the switch statement below
-     *
-     * @param array $attributes
-     * @return array
-     */
-    private function sanitizeAttributes(array $attributes)
-    {
-        $custom_sanitization = $this->customAttributeSanitizationMap();
-        foreach ($attributes as $key => $value) {
-            // is a custom sanitization callback specified ?
-            if (isset($custom_sanitization[$key])) {
-                $callback = $custom_sanitization[$key];
-                if ($callback === 'skip_sanitization') {
-                    $attributes[$key] = $value;
-                    continue;
-                }
-                if (function_exists($callback)) {
-                    $attributes[$key] = $callback($value);
-                    continue;
-                }
-            }
-            switch (true) {
-                case $value === null :
-                case is_int($value) :
-                case is_float($value) :
-                    // typical booleans
-                case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true) :
-                    $attributes[$key] = $value;
-                    break;
-                case is_string($value) :
-                    $attributes[$key] = sanitize_text_field($value);
-                    break;
-                case is_array($value) :
-                    $attributes[$key] = $this->sanitizeAttributes($value);
-                    break;
-                default :
-                    // only remaining data types are Object and Resource
-                    // which are not allowed as shortcode attributes
-                    $attributes[$key] = null;
-                    break;
-            }
-        }
-        return $attributes;
-    }
+	/**
+	 * transient prefix
+	 *
+	 * @type string
+	 */
+	const CACHE_TRANSIENT_PREFIX = 'ee_sc_';
+
+	/**
+	 * @var PostRelatedCacheManager $cache_manager
+	 */
+	private $cache_manager;
+
+	/**
+	 * true if ShortcodeInterface::initializeShortcode() has been called
+	 * if false, then that will get called before processing
+	 *
+	 * @var boolean $initialized
+	 */
+	private $initialized = false;
+
+
+
+	/**
+	 * EspressoShortcode constructor
+	 *
+	 * @param PostRelatedCacheManager $cache_manager
+	 */
+	public function __construct(PostRelatedCacheManager $cache_manager)
+	{
+		$this->cache_manager = $cache_manager;
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public function shortcodeHasBeenInitialized()
+	{
+		$this->initialized = true;
+	}
+
+
+
+	/**
+	 * enqueues scripts then processes the shortcode
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	final public function processShortcodeCallback($attributes = array())
+	{
+		if ($this instanceof EnqueueAssetsInterface) {
+			if (is_admin()) {
+				$this->enqueueAdminScripts();
+			} else {
+				$this->enqueueScripts();
+			}
+		}
+		return $this->shortcodeContent(
+			$this->sanitizeAttributes((array)$attributes)
+		);
+	}
+
+
+
+	/**
+	 * If shortcode caching is enabled for the shortcode,
+	 * and cached results exist, then that will be returned
+	 * else new content will be generated.
+	 * If caching is enabled, then the new content will be cached for later.
+	 *
+	 * @param array $attributes
+	 * @return mixed|string
+	 * @throws \EE_Error
+	 */
+	private function shortcodeContent(array $attributes)
+	{
+		$shortcode = $this;
+		$post_ID = $this->currentPostID();
+		// something like "SC_EVENTS-123"
+		$cache_ID = $this->shortcodeCacheID($post_ID);
+		$this->cache_manager->clearPostRelatedCacheOnUpdate($post_ID, $cache_ID);
+		return $this->cache_manager->get(
+			$cache_ID,
+			// serialized attributes
+			wp_json_encode($attributes),
+			// Closure for generating content if cache is expired
+			function () use ($shortcode, $attributes) {
+				if($shortcode->initialized === false){
+					$shortcode->initializeShortcode();
+				}
+				return $shortcode->processShortcode($attributes);
+			},
+			// filterable cache expiration set by each shortcode
+			apply_filters(
+				'FHEE__EventEspresso_core_services_shortcodes_EspressoShortcode__shortcodeContent__cache_expiration',
+				$this->cacheExpiration(),
+				$this->getTag(),
+				$this
+			)
+		);
+	}
+
+
+
+	/**
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	private function currentPostID()
+	{
+		// try to get EE_Event any way we can
+		$event = EEH_Event_View::get_event();
+		// then get some kind of ID
+		if ($event instanceof \EE_Event) {
+			$post_ID = $event->ID();
+		} else {
+			global $post;
+			$post_ID = $post->ID;
+		}
+		return $post_ID;
+	}
+
+
+
+	/**
+	 * @param int $post_ID
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	private function shortcodeCacheID($post_ID)
+	{
+		$tag = str_replace('ESPRESSO_', '', $this->getTag());
+		return "SC_{$tag}-{$post_ID}";
+	}
+
+
+
+	/**
+	 * array for defining custom attribute sanitization callbacks,
+	 * where keys match keys in your attributes array,
+	 * and values represent the sanitization function you wish to be applied to that attribute.
+	 * So for example, if you had an integer attribute named "event_id"
+	 * that you wanted to be sanitized using absint(),
+	 * then you would return the following:
+	 *      array('event_id' => 'absint')
+	 * Entering 'skip_sanitization' for the callback value
+	 * means that no sanitization will be applied
+	 * on the assumption that the attribute
+	 * will be sanitized at some point... right?
+	 * You wouldn't pass around unsanitized attributes would you?
+	 * That would be very Tom Foolery of you!!!
+	 *
+	 * @return array
+	 */
+	protected function customAttributeSanitizationMap()
+	{
+		return array();
+	}
+
+
+
+	/**
+	 * Performs basic sanitization on shortcode attributes
+	 * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
+	 * most attributes will by default be sanitized using the sanitize_text_field() function.
+	 * This can be overridden using the customAttributeSanitizationMap() method (see above),
+	 * all other attributes would be sanitized using the defaults in the switch statement below
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function sanitizeAttributes(array $attributes)
+	{
+		$custom_sanitization = $this->customAttributeSanitizationMap();
+		foreach ($attributes as $key => $value) {
+			// is a custom sanitization callback specified ?
+			if (isset($custom_sanitization[$key])) {
+				$callback = $custom_sanitization[$key];
+				if ($callback === 'skip_sanitization') {
+					$attributes[$key] = $value;
+					continue;
+				}
+				if (function_exists($callback)) {
+					$attributes[$key] = $callback($value);
+					continue;
+				}
+			}
+			switch (true) {
+				case $value === null :
+				case is_int($value) :
+				case is_float($value) :
+					// typical booleans
+				case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true) :
+					$attributes[$key] = $value;
+					break;
+				case is_string($value) :
+					$attributes[$key] = sanitize_text_field($value);
+					break;
+				case is_array($value) :
+					$attributes[$key] = $this->sanitizeAttributes($value);
+					break;
+				default :
+					// only remaining data types are Object and Resource
+					// which are not allowed as shortcode attributes
+					$attributes[$key] = null;
+					break;
+			}
+		}
+		return $attributes;
+	}
 
 
 

Spacing +3 added lines, -3 removed lines

@@ -81,7 +81,7 @@ 
             }
         }
         return $this->shortcodeContent(
-            $this->sanitizeAttributes((array)$attributes)
+            $this->sanitizeAttributes((array) $attributes)
         );
     }
 
@@ -109,8 +109,8 @@ 
             // serialized attributes
             wp_json_encode($attributes),
             // Closure for generating content if cache is expired
-            function () use ($shortcode, $attributes) {
-                if($shortcode->initialized === false){
+            function() use ($shortcode, $attributes) {
+                if ($shortcode->initialized === false) {
                     $shortcode->initializeShortcode();
                 }
                 return $shortcode->processShortcode($attributes);