eventespresso / event-espresso-core

core/domain/services/licensing/ActivateLicenseButton.php

Indentation +26 added lines, -26 removed lines

@@ -7,33 +7,33 @@ 
 
 class ActivateLicenseButton
 {
-    /**
-     * @param PluginLicense $plugin_license
-     * @param stdClass|null $license_data
-     * @return string
-     */
-    public static function html(PluginLicense $plugin_license, ?stdClass $license_data): string
-    {
-        $activate_btn_class   = '';
-        $deactivate_btn_class = '';
-        $license_status       = $license_data->license ?? '';
-        if ($license_status !== 'valid') {
-            $deactivate_btn_class = ' ee-license-action-btn--hidden';
-        } else {
-            $activate_btn_class = ' ee-license-action-btn--hidden';
-        }
+	/**
+	 * @param PluginLicense $plugin_license
+	 * @param stdClass|null $license_data
+	 * @return string
+	 */
+	public static function html(PluginLicense $plugin_license, ?stdClass $license_data): string
+	{
+		$activate_btn_class   = '';
+		$deactivate_btn_class = '';
+		$license_status       = $license_data->license ?? '';
+		if ($license_status !== 'valid') {
+			$deactivate_btn_class = ' ee-license-action-btn--hidden';
+		} else {
+			$activate_btn_class = ' ee-license-action-btn--hidden';
+		}
 
-        $activate_btn_label   = esc_html__('activate', 'event_espresso');
-        $deactivate_btn_label = esc_html__('deactivate', 'event_espresso');
-        $reset_btn_label      = esc_html__('reset/clear this license key', 'event_espresso');
+		$activate_btn_label   = esc_html__('activate', 'event_espresso');
+		$deactivate_btn_label = esc_html__('deactivate', 'event_espresso');
+		$reset_btn_label      = esc_html__('reset/clear this license key', 'event_espresso');
 
-        $item_id        = $plugin_license->itemID();
-        $item_name      = $plugin_license->itemName();
-        $plugin_slug    = $plugin_license->pluginSlug();
-        $min_core_ver   = $plugin_license->minCoreVersion();
-        $plugin_version = $plugin_license->version();
-        $disabled       = empty($license_data->license_key) ? 'disabled' : '';
-        return "
+		$item_id        = $plugin_license->itemID();
+		$item_name      = $plugin_license->itemName();
+		$plugin_slug    = $plugin_license->pluginSlug();
+		$min_core_ver   = $plugin_license->minCoreVersion();
+		$plugin_version = $plugin_license->version();
+		$disabled       = empty($license_data->license_key) ? 'disabled' : '';
+		return "
         <button id='activate-$plugin_slug'
                 class='ee-license-action-btn ee-license-action-btn__activate$activate_btn_class button button--primary'
                 data-action='activate_license'
@@ -73,5 +73,5 @@ 
         >
             <span class='dashicons dashicons-trash'></span>
         </button>";
-    }
+	}
 }

core/domain/services/licensing/LicenseKeysAdminForm.php

Indentation +98 added lines, -98 removed lines

@@ -14,107 +14,107 @@
 class LicenseKeysAdminForm extends FormHandler
 {
 
-    public function __construct(EE_Registry $registry)
-    {
-        parent::__construct(
-            LICENSE_KEYS_LABEL,
-            LICENSE_KEYS_LABEL,
-            LICENSE_KEYS_PG_SLUG,
-            '',
-            FormHandler::DO_NOT_SETUP_FORM,
-            $registry
-        );
-    }
+	public function __construct(EE_Registry $registry)
+	{
+		parent::__construct(
+			LICENSE_KEYS_LABEL,
+			LICENSE_KEYS_LABEL,
+			LICENSE_KEYS_PG_SLUG,
+			'',
+			FormHandler::DO_NOT_SETUP_FORM,
+			$registry
+		);
+	}
 
 
-    /**
-     * @throws EE_Error
-     */
-    public function generate(): EE_Form_Section_Proper
-    {
-        $subsections = (array) apply_filters('FHEE__LicenseKeysAdminForm__generate__form_subsections', []);
-        ksort($subsections);
-        return new EE_Form_Section_Proper(
-            [
-                'name'            => 'license_keys_admin_form',
-                'html_id'         => 'license_keys_admin_form',
-                'layout_strategy' => new EE_No_Layout(),
-                'subsections'     => $this->addCoreSupportLicenseKey($subsections),
-            ]
-        );
-    }
+	/**
+	 * @throws EE_Error
+	 */
+	public function generate(): EE_Form_Section_Proper
+	{
+		$subsections = (array) apply_filters('FHEE__LicenseKeysAdminForm__generate__form_subsections', []);
+		ksort($subsections);
+		return new EE_Form_Section_Proper(
+			[
+				'name'            => 'license_keys_admin_form',
+				'html_id'         => 'license_keys_admin_form',
+				'layout_strategy' => new EE_No_Layout(),
+				'subsections'     => $this->addCoreSupportLicenseKey($subsections),
+			]
+		);
+	}
 
 
-    private function addCoreSupportLicenseKey(array $subsections): array
-    {
-        // we want to move the license key input for core to a different location,
-        // so to do that we need to copy it, delete the old location, then add re-add to the form
-        $core_license_key = $subsections['event_espresso_core'] ?? null;
-        unset($subsections['event_espresso_core']);
-        $new_subsections = [
-            'license_keys_hdr'           => new EE_Form_Section_HTML(
-                EEH_HTML::h1(
-                    esc_html__('Event Espresso Core License & Support Keys', 'event_espresso'),
-                    '',
-                    'ee-admin-settings-hdr'
-                )
-            ),
-            'event_espresso_core'        => $core_license_key,
-            'support_license_notice'     => new EE_Form_Section_HTML(
-                EEH_HTML::br()
-                . EEH_HTML::div(
-                    '<span class="dashicons dashicons-sos"></span>'
-                    . EEH_HTML::span(
-                        esc_html__(
-                            'Adding a valid Support License Key will enable automatic update notifications and backend updates.',
-                            'event_espresso'
-                        )
-                    ),
-                    'support-license-notice-dv',
-                    'ee-status-outline ee-status-outline--micro ee-status-outline--info ee-status-bg--info'
-                )
-                . EEH_HTML::br()
-                . EEH_HTML::div(
-                    EEH_HTML::span(
-                        sprintf(
-                            esc_html__(
-                                'If this is a Development or Test site, %sDO NOT%s enter your Support License Key.',
-                                'event_espresso'
-                            ),
-                            '<strong>',
-                            '</strong>'
-                        )
-                    ),
-                    '',
-                    'ee-status-outline ee-status-outline--attention'
-                )
-            ),
-            'add-on-license-keys-hdr'    => new EE_Form_Section_HTML(
-                EEH_HTML::h2(
-                    esc_html__('Add-on License Keys', 'event_espresso'),
-                    '',
-                    'ee-admin-settings-hdr'
-                )
-            ),
-            'add-on-license-keys-notice' => new EE_Form_Section_HTML(
-                EEH_HTML::div(
-                    EEH_HTML::span(
-                        esc_html__(
-                            'Please activate an Event Espresso Core support license key first in order to activate your add-on license keys',
-                            'event_espresso'
-                        )
-                    ),
-                    'add-on-license-keys-notice-dv',
-                    'ee-status-outline ee-status-outline--micro ee-status-bg--attention',
-                    'display: none;'
-                )
-            ),
-        ];
+	private function addCoreSupportLicenseKey(array $subsections): array
+	{
+		// we want to move the license key input for core to a different location,
+		// so to do that we need to copy it, delete the old location, then add re-add to the form
+		$core_license_key = $subsections['event_espresso_core'] ?? null;
+		unset($subsections['event_espresso_core']);
+		$new_subsections = [
+			'license_keys_hdr'           => new EE_Form_Section_HTML(
+				EEH_HTML::h1(
+					esc_html__('Event Espresso Core License & Support Keys', 'event_espresso'),
+					'',
+					'ee-admin-settings-hdr'
+				)
+			),
+			'event_espresso_core'        => $core_license_key,
+			'support_license_notice'     => new EE_Form_Section_HTML(
+				EEH_HTML::br()
+				. EEH_HTML::div(
+					'<span class="dashicons dashicons-sos"></span>'
+					. EEH_HTML::span(
+						esc_html__(
+							'Adding a valid Support License Key will enable automatic update notifications and backend updates.',
+							'event_espresso'
+						)
+					),
+					'support-license-notice-dv',
+					'ee-status-outline ee-status-outline--micro ee-status-outline--info ee-status-bg--info'
+				)
+				. EEH_HTML::br()
+				. EEH_HTML::div(
+					EEH_HTML::span(
+						sprintf(
+							esc_html__(
+								'If this is a Development or Test site, %sDO NOT%s enter your Support License Key.',
+								'event_espresso'
+							),
+							'<strong>',
+							'</strong>'
+						)
+					),
+					'',
+					'ee-status-outline ee-status-outline--attention'
+				)
+			),
+			'add-on-license-keys-hdr'    => new EE_Form_Section_HTML(
+				EEH_HTML::h2(
+					esc_html__('Add-on License Keys', 'event_espresso'),
+					'',
+					'ee-admin-settings-hdr'
+				)
+			),
+			'add-on-license-keys-notice' => new EE_Form_Section_HTML(
+				EEH_HTML::div(
+					EEH_HTML::span(
+						esc_html__(
+							'Please activate an Event Espresso Core support license key first in order to activate your add-on license keys',
+							'event_espresso'
+						)
+					),
+					'add-on-license-keys-notice-dv',
+					'ee-status-outline ee-status-outline--micro ee-status-bg--attention',
+					'display: none;'
+				)
+			),
+		];
 
-        if ($core_license_key instanceof LicenseKeyFormInput && $core_license_key->get_default()) {
-            unset ($new_subsections['support_license_notice']);
-            unset ($new_subsections['add-on-license-keys-notice']);
-        }
-        return EEH_Array::insert_into_array($subsections, $new_subsections);
-    }
+		if ($core_license_key instanceof LicenseKeyFormInput && $core_license_key->get_default()) {
+			unset ($new_subsections['support_license_notice']);
+			unset ($new_subsections['add-on-license-keys-notice']);
+		}
+		return EEH_Array::insert_into_array($subsections, $new_subsections);
+	}
 }

core/domain/entities/editor/blocks/EventAttendees.php

Indentation +160 added lines, -160 removed lines

@@ -20,175 +20,175 @@
  */
 class EventAttendees extends Block
 {
-    const BLOCK_TYPE = 'event-attendees';
+	const BLOCK_TYPE = 'event-attendees';
 
-    /**
-     * @var EventAttendeesBlockRenderer $renderer
-     */
-    protected $renderer;
+	/**
+	 * @var EventAttendeesBlockRenderer $renderer
+	 */
+	protected $renderer;
 
 
-    /**
-     * EventAttendees constructor.
-     *
-     * @param CoreBlocksAssetManager      $block_asset_manager
-     * @param RequestInterface            $request
-     * @param EventAttendeesBlockRenderer $renderer
-     */
-    public function __construct(
-        CoreBlocksAssetManager $block_asset_manager,
-        RequestInterface $request,
-        EventAttendeesBlockRenderer $renderer
-    ) {
-        parent::__construct($block_asset_manager, $request);
-        $this->renderer = $renderer;
-    }
+	/**
+	 * EventAttendees constructor.
+	 *
+	 * @param CoreBlocksAssetManager      $block_asset_manager
+	 * @param RequestInterface            $request
+	 * @param EventAttendeesBlockRenderer $renderer
+	 */
+	public function __construct(
+		CoreBlocksAssetManager $block_asset_manager,
+		RequestInterface $request,
+		EventAttendeesBlockRenderer $renderer
+	) {
+		parent::__construct($block_asset_manager, $request);
+		$this->renderer = $renderer;
+	}
 
 
-    /**
-     * Perform any early setup required by the block
-     * including setting the block type and supported post types
-     *
-     * @return void
-     */
-    public function initialize()
-    {
-        $this->setBlockType(EventAttendees::BLOCK_TYPE);
-        $this->setSupportedRoutes(
-            array(
-                'EventEspresso\core\domain\entities\routing\specifications\admin\WordPressPostTypeEditor',
-                'EventEspresso\core\domain\entities\routing\specifications\frontend\EspressoBlockRenderer',
-                'EventEspresso\core\domain\entities\routing\specifications\frontend\AnyFrontendRequest'
-            )
-        );
-        $EVT_ID = $this->request->getRequestParam('page') === 'espresso_events'
-            ? $this->request->getRequestParam('post', 0, 'int')
-            : 0;
-        $this->setAttributes(
-            array(
-                'eventId'           => array(
-                    'type'    => 'number',
-                    'default' => $EVT_ID,
-                ),
-                'datetimeId'        => array(
-                    'type'    => 'number',
-                    'default' => 0,
-                ),
-                'ticketId'          => array(
-                    'type'    => 'number',
-                    'default' => 0,
-                ),
-                'status'            => array(
-                    'type'    => 'string',
-                    'default' => RegStatus::APPROVED,
-                ),
-                'limit'             => array(
-                    'type'    => 'number',
-                    'default' => 100,
-                ),
-                'order' => array(
-                    'type' => 'string',
-                    'default' => 'ASC'
-                ),
-                'orderBy' => array(
-                    'type' => 'string',
-                    'default' => 'lastThenFirstName',
-                ),
-                'showGravatar'      => array(
-                    'type'    => 'boolean',
-                    'default' => false,
-                ),
-                'avatarClass' => array(
-                    'type' => 'string',
-                    'default' => 'contact',
-                ),
-                'avatarSize' => array(
-                    'type' => 'number',
-                    'default' => 24,
-                ),
-                'displayOnArchives' => array(
-                    'type'    => 'boolean',
-                    'default' => false,
-                ),
-            )
-        );
-        $this->setDynamic();
-    }
+	/**
+	 * Perform any early setup required by the block
+	 * including setting the block type and supported post types
+	 *
+	 * @return void
+	 */
+	public function initialize()
+	{
+		$this->setBlockType(EventAttendees::BLOCK_TYPE);
+		$this->setSupportedRoutes(
+			array(
+				'EventEspresso\core\domain\entities\routing\specifications\admin\WordPressPostTypeEditor',
+				'EventEspresso\core\domain\entities\routing\specifications\frontend\EspressoBlockRenderer',
+				'EventEspresso\core\domain\entities\routing\specifications\frontend\AnyFrontendRequest'
+			)
+		);
+		$EVT_ID = $this->request->getRequestParam('page') === 'espresso_events'
+			? $this->request->getRequestParam('post', 0, 'int')
+			: 0;
+		$this->setAttributes(
+			array(
+				'eventId'           => array(
+					'type'    => 'number',
+					'default' => $EVT_ID,
+				),
+				'datetimeId'        => array(
+					'type'    => 'number',
+					'default' => 0,
+				),
+				'ticketId'          => array(
+					'type'    => 'number',
+					'default' => 0,
+				),
+				'status'            => array(
+					'type'    => 'string',
+					'default' => RegStatus::APPROVED,
+				),
+				'limit'             => array(
+					'type'    => 'number',
+					'default' => 100,
+				),
+				'order' => array(
+					'type' => 'string',
+					'default' => 'ASC'
+				),
+				'orderBy' => array(
+					'type' => 'string',
+					'default' => 'lastThenFirstName',
+				),
+				'showGravatar'      => array(
+					'type'    => 'boolean',
+					'default' => false,
+				),
+				'avatarClass' => array(
+					'type' => 'string',
+					'default' => 'contact',
+				),
+				'avatarSize' => array(
+					'type' => 'number',
+					'default' => 24,
+				),
+				'displayOnArchives' => array(
+					'type'    => 'boolean',
+					'default' => false,
+				),
+			)
+		);
+		$this->setDynamic();
+	}
 
 
-    /**
-     * Returns an array where the key corresponds to the incoming attribute name from the WP block
-     * and the value corresponds to the attribute name for the existing EspressoEventAttendees shortcode
-     *
-     * @since 4.9.71.p
-     * @return array
-     */
-    private function getAttributesMap()
-    {
-        return array(
-            'event'             => 'sanitize_text_field',
-            'datetime'          => 'sanitize_text_field',
-            'ticket'            => 'sanitize_text_field',
-            'eventId'           => 'absint',
-            'datetimeId'        => 'absint',
-            'ticketId'          => 'absint',
-            'status'            => 'sanitize_text_field',
-            'limit'             => 'intval',
-            'showGravatar'      => 'bool',
-            'avatarClass'       => 'sanitize_text_field',
-            'avatarSize'        => 'absint',
-            'displayOnArchives' => 'bool',
-            'order' => 'sanitize_text_field',
-            'orderBy' => 'sanitize_text_field',
-        );
-    }
+	/**
+	 * Returns an array where the key corresponds to the incoming attribute name from the WP block
+	 * and the value corresponds to the attribute name for the existing EspressoEventAttendees shortcode
+	 *
+	 * @since 4.9.71.p
+	 * @return array
+	 */
+	private function getAttributesMap()
+	{
+		return array(
+			'event'             => 'sanitize_text_field',
+			'datetime'          => 'sanitize_text_field',
+			'ticket'            => 'sanitize_text_field',
+			'eventId'           => 'absint',
+			'datetimeId'        => 'absint',
+			'ticketId'          => 'absint',
+			'status'            => 'sanitize_text_field',
+			'limit'             => 'intval',
+			'showGravatar'      => 'bool',
+			'avatarClass'       => 'sanitize_text_field',
+			'avatarSize'        => 'absint',
+			'displayOnArchives' => 'bool',
+			'order' => 'sanitize_text_field',
+			'orderBy' => 'sanitize_text_field',
+		);
+	}
 
 
-    /**
-     * Sanitizes attributes.
-     *
-     * @param array $attributes
-     * @return array
-     */
-    private function sanitizeAttributes(array $attributes)
-    {
-        $sanitized_attributes = array();
-        foreach ($attributes as $attribute => $value) {
-            $convert = $this->getAttributesMap();
-            if (isset($convert[ $attribute ])) {
-                $sanitize = $convert[ $attribute ];
-                if ($sanitize === 'bool') {
-                    $sanitized_attributes[ $attribute ] = filter_var(
-                        $value,
-                        FILTER_VALIDATE_BOOLEAN
-                    );
-                } else {
-                    $sanitized_attributes[ $attribute ] = $sanitize($value);
-                }
-                // don't pass along attributes with a 0 value
-                if ($sanitized_attributes[ $attribute ] === 0) {
-                    unset($sanitized_attributes[ $attribute ]);
-                }
-            }
-        }
-        return $attributes;
-    }
+	/**
+	 * Sanitizes attributes.
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function sanitizeAttributes(array $attributes)
+	{
+		$sanitized_attributes = array();
+		foreach ($attributes as $attribute => $value) {
+			$convert = $this->getAttributesMap();
+			if (isset($convert[ $attribute ])) {
+				$sanitize = $convert[ $attribute ];
+				if ($sanitize === 'bool') {
+					$sanitized_attributes[ $attribute ] = filter_var(
+						$value,
+						FILTER_VALIDATE_BOOLEAN
+					);
+				} else {
+					$sanitized_attributes[ $attribute ] = $sanitize($value);
+				}
+				// don't pass along attributes with a 0 value
+				if ($sanitized_attributes[ $attribute ] === 0) {
+					unset($sanitized_attributes[ $attribute ]);
+				}
+			}
+		}
+		return $attributes;
+	}
 
 
-    /**
-     * Returns the rendered HTML for the block
-     *
-     * @param array $attributes
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function renderBlock(array $attributes = array())
-    {
-        $attributes = $this->sanitizeAttributes($attributes);
-        if (! (bool) $attributes['displayOnArchives'] && (is_archive() || is_front_page() || is_home())) {
-            return '';
-        }
-        return $this->renderer->render($attributes);
-    }
+	/**
+	 * Returns the rendered HTML for the block
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function renderBlock(array $attributes = array())
+	{
+		$attributes = $this->sanitizeAttributes($attributes);
+		if (! (bool) $attributes['displayOnArchives'] && (is_archive() || is_front_page() || is_home())) {
+			return '';
+		}
+		return $this->renderer->render($attributes);
+	}
 }

core/domain/entities/contexts/RequestTypeContext.php

Indentation +181 added lines, -181 removed lines

@@ -15,185 +15,185 @@
  */
 class RequestTypeContext extends Context
 {
-    /**
-     * indicates that the current request involves some form of activation
-     */
-    const ACTIVATION = 'activation-request';
-
-    /**
-     * indicates that the current request is for the admin but is not being made via AJAX
-     */
-    const ADMIN = 'non-ajax-admin-request';
-
-    /**
-     * indicates that the current request is for the admin AND is being made via AJAX
-     */
-    const AJAX_ADMIN = 'admin-ajax-request';
-
-    /**
-     * indicates that the current request is for the frontend AND is being made via AJAX
-     */
-    const AJAX_FRONT = 'frontend-ajax-request';
-
-    /**
-     * indicates that the current request is for the WP Heartbeat
-     */
-    const AJAX_HEARTBEAT = 'admin-ajax-heartbeat';
-
-    /**
-     * indicates that the current request is being made via AJAX, but is NOT for EE
-     */
-    const AJAX_OTHER = 'other-ajax-request';
-
-    /**
-     * indicates that the current request is for the EE REST API
-     */
-    const API = 'rest-api';
-
-    /**
-     * indicates that the current request is from the command line
-     */
-    const CLI = 'command-line';
-
-    /**
-     * indicates that the current request is for a WP_Cron
-     */
-    const CRON = 'wp-cron';
-
-    /**
-     * indicates that the current request is for a feed (ie: RSS)
-     */
-    const FEED = 'feed-request';
-
-    /**
-     * indicates that the current request is for the frontend but is not being made via AJAX
-     */
-    const FRONTEND = 'non-ajax-frontend-request';
-
-    /**
-     * indicates that the current request is for content that is to be displayed within an iframe
-     */
-    const IFRAME = 'iframe-request';
-
-    /**
-     * indicates that the current request is for the EE GraphQL manager
-     */
-    const GQL = 'graphql';
-
-    /**
-     * indicates that the current request is for the WP REST API
-     */
-    const WP_API = 'wp-rest-api';
-
-    /**
-     * indicates that the current request is a loopback sent from WP core to test for errors
-     */
-    const WP_SCRAPE = 'wordpress-scrape';
-
-    /**
-     * @var boolean $is_activation
-     */
-    private bool $is_activation = false;
-
-    /**
-     * @var boolean $is_unit_testing
-     */
-    private bool $is_unit_testing = false;
-
-    /**
-     * @var array $valid_request_types
-     */
-    private array $valid_request_types = array();
-
-
-    /**
-     * RequestTypeContext constructor.
-     *
-     * @param string $slug
-     * @param string $description
-     * @throws InvalidArgumentException
-     */
-    public function __construct($slug, $description)
-    {
-        parent::__construct($slug, $description);
-        if (! in_array($this->slug(), $this->validRequestTypes(), true)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The RequestTypeContext slug must be one of the following values: %1$s %2$s',
-                        'event_espresso'
-                    ),
-                    '<br />',
-                    var_export($this->validRequestTypes(), true)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public function validRequestTypes(): array
-    {
-        if (empty($this->valid_request_types)) {
-            $this->valid_request_types = apply_filters(
-                'FHEE__EventEspresso_core_domain_entities_contexts_RequestTypeContext__validRequestTypes',
-                array(
-                    RequestTypeContext::ACTIVATION,
-                    RequestTypeContext::ADMIN,
-                    RequestTypeContext::AJAX_ADMIN,
-                    RequestTypeContext::AJAX_FRONT,
-                    RequestTypeContext::AJAX_HEARTBEAT,
-                    RequestTypeContext::AJAX_OTHER,
-                    RequestTypeContext::API,
-                    RequestTypeContext::CLI,
-                    RequestTypeContext::CRON,
-                    RequestTypeContext::FEED,
-                    RequestTypeContext::FRONTEND,
-                    RequestTypeContext::GQL,
-                    RequestTypeContext::IFRAME,
-                    RequestTypeContext::WP_API,
-                    RequestTypeContext::WP_SCRAPE,
-                )
-            );
-        }
-        return $this->valid_request_types;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActivation(): bool
-    {
-        return $this->is_activation || $this->slug() === RequestTypeContext::ACTIVATION;
-    }
-
-
-    /**
-     * @param bool $is_activation
-     */
-    public function setIsActivation(bool $is_activation = false)
-    {
-        $this->is_activation = filter_var($is_activation, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isUnitTesting(): bool
-    {
-        return $this->is_unit_testing;
-    }
-
-
-    /**
-     * @param bool $is_unit_testing
-     */
-    public function setIsUnitTesting(bool $is_unit_testing = false)
-    {
-        $this->is_unit_testing = filter_var($is_unit_testing, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * indicates that the current request involves some form of activation
+	 */
+	const ACTIVATION = 'activation-request';
+
+	/**
+	 * indicates that the current request is for the admin but is not being made via AJAX
+	 */
+	const ADMIN = 'non-ajax-admin-request';
+
+	/**
+	 * indicates that the current request is for the admin AND is being made via AJAX
+	 */
+	const AJAX_ADMIN = 'admin-ajax-request';
+
+	/**
+	 * indicates that the current request is for the frontend AND is being made via AJAX
+	 */
+	const AJAX_FRONT = 'frontend-ajax-request';
+
+	/**
+	 * indicates that the current request is for the WP Heartbeat
+	 */
+	const AJAX_HEARTBEAT = 'admin-ajax-heartbeat';
+
+	/**
+	 * indicates that the current request is being made via AJAX, but is NOT for EE
+	 */
+	const AJAX_OTHER = 'other-ajax-request';
+
+	/**
+	 * indicates that the current request is for the EE REST API
+	 */
+	const API = 'rest-api';
+
+	/**
+	 * indicates that the current request is from the command line
+	 */
+	const CLI = 'command-line';
+
+	/**
+	 * indicates that the current request is for a WP_Cron
+	 */
+	const CRON = 'wp-cron';
+
+	/**
+	 * indicates that the current request is for a feed (ie: RSS)
+	 */
+	const FEED = 'feed-request';
+
+	/**
+	 * indicates that the current request is for the frontend but is not being made via AJAX
+	 */
+	const FRONTEND = 'non-ajax-frontend-request';
+
+	/**
+	 * indicates that the current request is for content that is to be displayed within an iframe
+	 */
+	const IFRAME = 'iframe-request';
+
+	/**
+	 * indicates that the current request is for the EE GraphQL manager
+	 */
+	const GQL = 'graphql';
+
+	/**
+	 * indicates that the current request is for the WP REST API
+	 */
+	const WP_API = 'wp-rest-api';
+
+	/**
+	 * indicates that the current request is a loopback sent from WP core to test for errors
+	 */
+	const WP_SCRAPE = 'wordpress-scrape';
+
+	/**
+	 * @var boolean $is_activation
+	 */
+	private bool $is_activation = false;
+
+	/**
+	 * @var boolean $is_unit_testing
+	 */
+	private bool $is_unit_testing = false;
+
+	/**
+	 * @var array $valid_request_types
+	 */
+	private array $valid_request_types = array();
+
+
+	/**
+	 * RequestTypeContext constructor.
+	 *
+	 * @param string $slug
+	 * @param string $description
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($slug, $description)
+	{
+		parent::__construct($slug, $description);
+		if (! in_array($this->slug(), $this->validRequestTypes(), true)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The RequestTypeContext slug must be one of the following values: %1$s %2$s',
+						'event_espresso'
+					),
+					'<br />',
+					var_export($this->validRequestTypes(), true)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function validRequestTypes(): array
+	{
+		if (empty($this->valid_request_types)) {
+			$this->valid_request_types = apply_filters(
+				'FHEE__EventEspresso_core_domain_entities_contexts_RequestTypeContext__validRequestTypes',
+				array(
+					RequestTypeContext::ACTIVATION,
+					RequestTypeContext::ADMIN,
+					RequestTypeContext::AJAX_ADMIN,
+					RequestTypeContext::AJAX_FRONT,
+					RequestTypeContext::AJAX_HEARTBEAT,
+					RequestTypeContext::AJAX_OTHER,
+					RequestTypeContext::API,
+					RequestTypeContext::CLI,
+					RequestTypeContext::CRON,
+					RequestTypeContext::FEED,
+					RequestTypeContext::FRONTEND,
+					RequestTypeContext::GQL,
+					RequestTypeContext::IFRAME,
+					RequestTypeContext::WP_API,
+					RequestTypeContext::WP_SCRAPE,
+				)
+			);
+		}
+		return $this->valid_request_types;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActivation(): bool
+	{
+		return $this->is_activation || $this->slug() === RequestTypeContext::ACTIVATION;
+	}
+
+
+	/**
+	 * @param bool $is_activation
+	 */
+	public function setIsActivation(bool $is_activation = false)
+	{
+		$this->is_activation = filter_var($is_activation, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isUnitTesting(): bool
+	{
+		return $this->is_unit_testing;
+	}
+
+
+	/**
+	 * @param bool $is_unit_testing
+	 */
+	public function setIsUnitTesting(bool $is_unit_testing = false)
+	{
+		$this->is_unit_testing = filter_var($is_unit_testing, FILTER_VALIDATE_BOOLEAN);
+	}
 }

core/domain/entities/routing/handlers/admin/EspressoLegacyAdmin.php

Indentation +136 added lines, -136 removed lines

@@ -17,146 +17,146 @@
  */
 class EspressoLegacyAdmin extends AdminRoute
 {
-    /**
-     * @var LegacyAccountingAssetManager $asset_manager
-     */
-    protected $asset_manager;
+	/**
+	 * @var LegacyAccountingAssetManager $asset_manager
+	 */
+	protected $asset_manager;
 
 
-    /**
-     * returns true if the current request matches this route
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        global $pagenow;
-        $page = $this->request->getRequestParam('page');
-        return ($pagenow === 'admin.php' || $pagenow === 'admin-ajax.php')
-               && (
-                   $page === 'pricing'
-                   || str_contains($page, 'espresso')
-                   || apply_filters(
-                       'FHEE__EspressoLegacyAdmin__matchesCurrentRequest__page',
-                       false,
-                       $page
-                   )
-               )
-               && parent::matchesCurrentRequest();
-    }
+	/**
+	 * returns true if the current request matches this route
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		global $pagenow;
+		$page = $this->request->getRequestParam('page');
+		return ($pagenow === 'admin.php' || $pagenow === 'admin-ajax.php')
+			   && (
+				   $page === 'pricing'
+				   || str_contains($page, 'espresso')
+				   || apply_filters(
+					   'FHEE__EspressoLegacyAdmin__matchesCurrentRequest__page',
+					   false,
+					   $page
+				   )
+			   )
+			   && parent::matchesCurrentRequest();
+	}
 
 
-    /**
-     * @since 5.0.0.p
-     */
-    protected function registerDependencies()
-    {
-        $asset_manger_dependencies = [
-            'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
-            'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_new_object,
-            'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
-        ];
-        $this->dependency_map->registerDependencies(JqueryAssetManager::class, $asset_manger_dependencies);
-        $this->dependency_map->registerDependencies(EspressoLegacyAdminAssetManager::class, $asset_manger_dependencies);
-        $this->dependency_map->registerDependencies(
-            LegacyAccountingAssetManager::class,
-            ['EE_Currency_Config' => EE_Dependency_Map::load_from_cache] + $asset_manger_dependencies
-        );
-        $this->dependency_map->registerDependencies(
-            'EE_Admin_Transactions_List_Table',
-            [
-                null,
-                'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\caffeinated\modules\recaptcha_invisible\RecaptchaAdminSettings',
-            ['EE_Registration_Config' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\admin_pages\general_settings\OrganizationSettings',
-            [
-                'EE_Registry'                                                  => EE_Dependency_Map::load_from_cache,
-                'EE_Organization_Config'                                       => EE_Dependency_Map::load_from_cache,
-                'EE_Core_Config'                                               => EE_Dependency_Map::load_from_cache,
-                'EE_Network_Core_Config'                                       => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\address\CountrySubRegionDao'      => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\capabilities\FeatureFlags' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\services\address\CountrySubRegionDao',
-            [
-                'EEM_State'                                            => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\validators\JsonValidator' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\admin\registrations\list_table\QueryBuilder',
-            [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EEM_Registration'                            => EE_Dependency_Map::load_from_cache,
-                null,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\AttendeeFilterHeader',
-            [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EEM_Attendee'                                => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\DateFilterHeader',
-            [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EEM_Datetime'                                => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\EventFilterHeader',
-            [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EEM_Event'                                   => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\TicketFilterHeader',
-            [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EEM_Ticket'                                  => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\services\admin\AdminListTableFilters',
-            [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-    }
+	/**
+	 * @since 5.0.0.p
+	 */
+	protected function registerDependencies()
+	{
+		$asset_manger_dependencies = [
+			'EventEspresso\core\domain\Domain'                   => EE_Dependency_Map::load_from_cache,
+			'EventEspresso\core\services\assets\AssetCollection' => EE_Dependency_Map::load_new_object,
+			'EventEspresso\core\services\assets\Registry'        => EE_Dependency_Map::load_from_cache,
+		];
+		$this->dependency_map->registerDependencies(JqueryAssetManager::class, $asset_manger_dependencies);
+		$this->dependency_map->registerDependencies(EspressoLegacyAdminAssetManager::class, $asset_manger_dependencies);
+		$this->dependency_map->registerDependencies(
+			LegacyAccountingAssetManager::class,
+			['EE_Currency_Config' => EE_Dependency_Map::load_from_cache] + $asset_manger_dependencies
+		);
+		$this->dependency_map->registerDependencies(
+			'EE_Admin_Transactions_List_Table',
+			[
+				null,
+				'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\caffeinated\modules\recaptcha_invisible\RecaptchaAdminSettings',
+			['EE_Registration_Config' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\admin_pages\general_settings\OrganizationSettings',
+			[
+				'EE_Registry'                                                  => EE_Dependency_Map::load_from_cache,
+				'EE_Organization_Config'                                       => EE_Dependency_Map::load_from_cache,
+				'EE_Core_Config'                                               => EE_Dependency_Map::load_from_cache,
+				'EE_Network_Core_Config'                                       => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\address\CountrySubRegionDao'      => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\capabilities\FeatureFlags' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\services\address\CountrySubRegionDao',
+			[
+				'EEM_State'                                            => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\validators\JsonValidator' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\admin\registrations\list_table\QueryBuilder',
+			[
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EEM_Registration'                            => EE_Dependency_Map::load_from_cache,
+				null,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\AttendeeFilterHeader',
+			[
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EEM_Attendee'                                => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\DateFilterHeader',
+			[
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EEM_Datetime'                                => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\EventFilterHeader',
+			[
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EEM_Event'                                   => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\TicketFilterHeader',
+			[
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EEM_Ticket'                                  => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\services\admin\AdminListTableFilters',
+			[
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+	}
 
 
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    protected function requestHandler(): bool
-    {
-        add_filter(
-            'admin_body_class',
-            function ($classes) {
-                if (strpos($classes, 'espresso-admin') === false) {
-                    $classes .= ' espresso-admin';
-                }
-                return $classes;
-            }
-        );
-        $this->loader->getShared(JqueryAssetManager::class);
-        $this->loader->getShared(EspressoLegacyAdminAssetManager::class);
-        $this->loader->getShared(LegacyAccountingAssetManager::class);
-        return true;
-    }
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	protected function requestHandler(): bool
+	{
+		add_filter(
+			'admin_body_class',
+			function ($classes) {
+				if (strpos($classes, 'espresso-admin') === false) {
+					$classes .= ' espresso-admin';
+				}
+				return $classes;
+			}
+		);
+		$this->loader->getShared(JqueryAssetManager::class);
+		$this->loader->getShared(EspressoLegacyAdminAssetManager::class);
+		$this->loader->getShared(LegacyAccountingAssetManager::class);
+		return true;
+	}
 }

core/domain/entities/routing/data_nodes/core/Locale.php

Indentation +23 added lines, -23 removed lines

@@ -16,30 +16,30 @@
  */
 class Locale extends JsonDataNode
 {
-    const NODE_NAME = 'locale';
+	const NODE_NAME = 'locale';
 
 
-    /**
-     * @param JsonDataNodeValidator $validator
-     */
-    public function __construct(JsonDataNodeValidator $validator)
-    {
-        parent::__construct($validator);
-        $this->setNodeName(Locale::NODE_NAME);
-    }
+	/**
+	 * @param JsonDataNodeValidator $validator
+	 */
+	public function __construct(JsonDataNodeValidator $validator)
+	{
+		parent::__construct($validator);
+		$this->setNodeName(Locale::NODE_NAME);
+	}
 
-    /**
-     * @inheritDoc
-     */
-    public function initialize()
-    {
-        $this->addData('user', get_user_locale());
-        $this->addData('site', get_locale());
-        $this->addData('siteTimezone', [
-            'city'   => EEH_DTT_Helper::get_timezone_string_for_display(),
-            'name'   => EEH_DTT_Helper::get_valid_timezone_string(wp_timezone_string()),
-            'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(),
-        ]);
-        $this->setInitialized(true);
-    }
+	/**
+	 * @inheritDoc
+	 */
+	public function initialize()
+	{
+		$this->addData('user', get_user_locale());
+		$this->addData('site', get_locale());
+		$this->addData('siteTimezone', [
+			'city'   => EEH_DTT_Helper::get_timezone_string_for_display(),
+			'name'   => EEH_DTT_Helper::get_valid_timezone_string(wp_timezone_string()),
+			'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(),
+		]);
+		$this->setInitialized(true);
+	}
 }

core/domain/entities/shortcodes/EspressoCancelled.php

Indentation +73 added lines, -73 removed lines

@@ -21,83 +21,83 @@
  */
 class EspressoCancelled extends EspressoShortcode
 {
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_CANCELLED';
-    }
+	/**
+	 * 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;
-    }
+	/**
+	 * 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();
-    }
+	/**
+	 * 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|string $attributes
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function processShortcode($attributes = array())
-    {
-        $session = EE_Registry::instance()->SSN;
-        if (! $session instanceof EE_Session) {
-            return '';
-        }
-        $transaction = $session->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 ($session->cart() instanceof EE_Cart) {
-            $session->cart()->delete_cart();
-        }
-        $session->clear_session(__CLASS__, __FUNCTION__);
-        // phpcs:disable WordPress.WP.I18n.UnorderedPlaceholdersText
-        return sprintf(
-            esc_html__(
-                '%sAll unsaved registration information entered during this session has been deleted.%s',
-                'event_espresso'
-            ),
-            '<p class="ee-registrations-cancelled-pg ee-attention">',
-            '</p>'
-        );
-        // phpcs:enable
-    }
+	/**
+	 * 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|string $attributes
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function processShortcode($attributes = array())
+	{
+		$session = EE_Registry::instance()->SSN;
+		if (! $session instanceof EE_Session) {
+			return '';
+		}
+		$transaction = $session->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 ($session->cart() instanceof EE_Cart) {
+			$session->cart()->delete_cart();
+		}
+		$session->clear_session(__CLASS__, __FUNCTION__);
+		// phpcs:disable WordPress.WP.I18n.UnorderedPlaceholdersText
+		return sprintf(
+			esc_html__(
+				'%sAll unsaved registration information entered during this session has been deleted.%s',
+				'event_espresso'
+			),
+			'<p class="ee-registrations-cancelled-pg ee-attention">',
+			'</p>'
+		);
+		// phpcs:enable
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -70,7 +70,7 @@
     public function processShortcode($attributes = array())
     {
         $session = EE_Registry::instance()->SSN;
-        if (! $session instanceof EE_Session) {
+        if ( ! $session instanceof EE_Session) {
             return '';
         }
         $transaction = $session->get_session_data('transaction');

core/domain/entities/shortcodes/EspressoEventAttendees.php

Indentation +313 added lines, -313 removed lines

@@ -33,342 +33,342 @@
  */
 class EspressoEventAttendees extends EspressoShortcode
 {
-    private $query_params = array(
-        0 => array(),
-    );
+	private $query_params = array(
+		0 => array(),
+	);
 
-    private $template_args = array(
-        'contacts' => array(),
-        'event'    => null,
-        'datetime' => null,
-        'ticket'   => null,
-    );
+	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 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 0;
-    }
+	/**
+	 * 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();
-    }
+	/**
+	 * 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.
-     *  [ESPRESSO_EVENT_ATTENDEES display_on_archives=true]
-     *  - default is to not display attendees list on archive pages.
-     * 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|string $attributes
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws DomainException
-     * @throws ReflectionException
-     */
-    public function processShortcode($attributes = array())
-    {
-        // grab attributes and merge with defaults
-        $attributes = $this->getAttributes((array) $attributes);
-        $attributes['limit'] = (int) $attributes['limit'];
-        $display_on_archives = filter_var($attributes['display_on_archives'], FILTER_VALIDATE_BOOLEAN);
-        // don't display on archives unless 'display_on_archives' is true
-        if ($attributes['limit'] === 0 || (! $display_on_archives && is_archive())) {
-            return '';
-        }
-        try {
-            $this->setBaseTemplateArguments($attributes);
-            $this->validateEntities($attributes);
-            $this->setBaseQueryParams();
-        } catch (EntityNotFoundException $e) {
-            if (WP_DEBUG) {
-                return '<div class="important-notice ee-error">'
-                       . $e->getMessage()
-                       . '</div>';
-            }
-            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
-        );
-    }
+	/**
+	 * 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.
+	 *  [ESPRESSO_EVENT_ATTENDEES display_on_archives=true]
+	 *  - default is to not display attendees list on archive pages.
+	 * 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|string $attributes
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws DomainException
+	 * @throws ReflectionException
+	 */
+	public function processShortcode($attributes = array())
+	{
+		// grab attributes and merge with defaults
+		$attributes = $this->getAttributes((array) $attributes);
+		$attributes['limit'] = (int) $attributes['limit'];
+		$display_on_archives = filter_var($attributes['display_on_archives'], FILTER_VALIDATE_BOOLEAN);
+		// don't display on archives unless 'display_on_archives' is true
+		if ($attributes['limit'] === 0 || (! $display_on_archives && is_archive())) {
+			return '';
+		}
+		try {
+			$this->setBaseTemplateArguments($attributes);
+			$this->validateEntities($attributes);
+			$this->setBaseQueryParams();
+		} catch (EntityNotFoundException $e) {
+			if (WP_DEBUG) {
+				return '<div class="important-notice ee-error">'
+					   . $e->getMessage()
+					   . '</div>';
+			}
+			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
+		);
+	}
 
 
-    /**
-     * merge incoming attributes with filtered defaults
-     *
-     * @param array $attributes
-     * @return array
-     */
-    private function getAttributes(array $attributes): array
-    {
-        return (array) apply_filters(
-            'EES_Espresso_Event_Attendees__process_shortcode__default_shortcode_atts',
-            $attributes + array(
-                'event_id'            => null,
-                'datetime_id'         => null,
-                'ticket_id'           => null,
-                'status'              => RegStatus::APPROVED,
-                'show_gravatar'       => false,
-                'display_on_archives' => false,
-                'limit'               => 999,
-            )
-        );
-    }
+	/**
+	 * merge incoming attributes with filtered defaults
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function getAttributes(array $attributes): array
+	{
+		return (array) apply_filters(
+			'EES_Espresso_Event_Attendees__process_shortcode__default_shortcode_atts',
+			$attributes + array(
+				'event_id'            => null,
+				'datetime_id'         => null,
+				'ticket_id'           => null,
+				'status'              => RegStatus::APPROVED,
+				'show_gravatar'       => false,
+				'display_on_archives' => false,
+				'limit'               => 999,
+			)
+		);
+	}
 
 
-    /**
-     * Set all the base template arguments from the incoming attributes.
-     * * 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
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    private function setBaseTemplateArguments(array $attributes)
-    {
-        $this->template_args['show_gravatar'] = $attributes['show_gravatar'];
-        $this->template_args['event'] = $this->getEvent($attributes);
-        $this->template_args['datetime'] = empty($attributes['event_id'])
-            ? $this->getDatetime($attributes)
-            : null;
-        $this->template_args['ticket'] = empty($attributes['datetime_id']) && empty($attributes['event_id'])
-            ? $this->getTicket($attributes)
-            : null;
-    }
+	/**
+	 * Set all the base template arguments from the incoming attributes.
+	 * * 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
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	private function setBaseTemplateArguments(array $attributes)
+	{
+		$this->template_args['show_gravatar'] = $attributes['show_gravatar'];
+		$this->template_args['event'] = $this->getEvent($attributes);
+		$this->template_args['datetime'] = empty($attributes['event_id'])
+			? $this->getDatetime($attributes)
+			: null;
+		$this->template_args['ticket'] = empty($attributes['datetime_id']) && empty($attributes['event_id'])
+			? $this->getTicket($attributes)
+			: null;
+	}
 
 
-    /**
-     * Validates the presence of entities for the given attribute values.
-     *
-     * @param array $attributes
-     * @throws EntityNotFoundException
-     */
-    private function validateEntities(array $attributes)
-    {
-        if (
-            ! $this->template_args['event'] instanceof EE_Event
-            || (
-                empty($attributes['event_id'])
-                && $attributes['datetime_id']
-                && ! $this->template_args['datetime'] instanceof EE_Datetime
-            )
-            || (
-                empty($attributes['event_id'])
-                && empty($attributes['datetime_id'])
-                && $attributes['ticket_id']
-                && ! $this->template_args['ticket'] instanceof EE_Ticket
-            )
-        ) {
-            throw new EntityNotFoundException(
-                '',
-                '',
-                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'
-                )
-            );
-        }
-    }
+	/**
+	 * Validates the presence of entities for the given attribute values.
+	 *
+	 * @param array $attributes
+	 * @throws EntityNotFoundException
+	 */
+	private function validateEntities(array $attributes)
+	{
+		if (
+			! $this->template_args['event'] instanceof EE_Event
+			|| (
+				empty($attributes['event_id'])
+				&& $attributes['datetime_id']
+				&& ! $this->template_args['datetime'] instanceof EE_Datetime
+			)
+			|| (
+				empty($attributes['event_id'])
+				&& empty($attributes['datetime_id'])
+				&& $attributes['ticket_id']
+				&& ! $this->template_args['ticket'] instanceof EE_Ticket
+			)
+		) {
+			throw new EntityNotFoundException(
+				'',
+				'',
+				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'
+				)
+			);
+		}
+	}
 
 
-    /**
-     * Sets the query params for the base query elements.
-     */
-    private function setBaseQueryParams()
-    {
-        switch (true) {
-            case $this->template_args['datetime'] instanceof EE_Datetime:
-                $this->query_params = array(
-                    0                          => array(
-                        'Registration.Ticket.Datetime.DTT_ID' => $this->template_args['datetime']->ID(),
-                    ),
-                    'default_where_conditions' => 'this_model_only',
-                );
-                break;
-            case $this->template_args['ticket'] instanceof EE_Ticket:
-                $this->query_params[0] = array(
-                    'Registration.TKT_ID' => $this->template_args['ticket']->ID(),
-                );
-                break;
-            case $this->template_args['event'] instanceof EE_Event:
-                $this->query_params[0] = array(
-                    'Registration.EVT_ID' => $this->template_args['event']->ID(),
-                );
-                break;
-        }
-    }
+	/**
+	 * Sets the query params for the base query elements.
+	 */
+	private function setBaseQueryParams()
+	{
+		switch (true) {
+			case $this->template_args['datetime'] instanceof EE_Datetime:
+				$this->query_params = array(
+					0                          => array(
+						'Registration.Ticket.Datetime.DTT_ID' => $this->template_args['datetime']->ID(),
+					),
+					'default_where_conditions' => 'this_model_only',
+				);
+				break;
+			case $this->template_args['ticket'] instanceof EE_Ticket:
+				$this->query_params[0] = array(
+					'Registration.TKT_ID' => $this->template_args['ticket']->ID(),
+				);
+				break;
+			case $this->template_args['event'] instanceof EE_Event:
+				$this->query_params[0] = array(
+					'Registration.EVT_ID' => $this->template_args['event']->ID(),
+				);
+				break;
+		}
+	}
 
 
-    /**
-     * @param array $attributes
-     * @return EE_Event|null
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    private function getEvent(array $attributes): ?EE_Event
-    {
-        switch (true) {
-            case ! empty($attributes['event_id']):
-                $event = EEM_Event::instance()->get_one_by_ID($attributes['event_id']);
-                break;
-            case ! empty($attributes['datetime_id']):
-                $event = EEM_Event::instance()->get_one(array(
-                    array(
-                        'Datetime.DTT_ID' => $attributes['datetime_id'],
-                    ),
-                ));
-                break;
-            case ! empty($attributes['ticket_id']):
-                $event = EEM_Event::instance()->get_one(array(
-                    array(
-                        'Datetime.Ticket.TKT_ID' => $attributes['ticket_id'],
-                    ),
-                    'default_where_conditions' => 'none'
-                ));
-                break;
-            case is_espresso_event():
-                $event = EEH_Event_View::get_event();
-                break;
-            default:
-                // 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);
-        }
+	/**
+	 * @param array $attributes
+	 * @return EE_Event|null
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	private function getEvent(array $attributes): ?EE_Event
+	{
+		switch (true) {
+			case ! empty($attributes['event_id']):
+				$event = EEM_Event::instance()->get_one_by_ID($attributes['event_id']);
+				break;
+			case ! empty($attributes['datetime_id']):
+				$event = EEM_Event::instance()->get_one(array(
+					array(
+						'Datetime.DTT_ID' => $attributes['datetime_id'],
+					),
+				));
+				break;
+			case ! empty($attributes['ticket_id']):
+				$event = EEM_Event::instance()->get_one(array(
+					array(
+						'Datetime.Ticket.TKT_ID' => $attributes['ticket_id'],
+					),
+					'default_where_conditions' => 'none'
+				));
+				break;
+			case is_espresso_event():
+				$event = EEH_Event_View::get_event();
+				break;
+			default:
+				// 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);
+		}
 
-        return $event instanceof EE_Event ? $event : null;
-    }
+		return $event instanceof EE_Event ? $event : null;
+	}
 
 
-    /**
-     * @param array $attributes
-     * @return EE_Datetime|null
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    private function getDatetime(array $attributes): ?EE_Datetime
-    {
-        if (! empty($attributes['datetime_id'])) {
-            $datetime = EEM_Datetime::instance()->get_one_by_ID($attributes['datetime_id']);
-            if ($datetime instanceof EE_Datetime) {
-                return $datetime;
-            }
-        }
-        return null;
-    }
+	/**
+	 * @param array $attributes
+	 * @return EE_Datetime|null
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	private function getDatetime(array $attributes): ?EE_Datetime
+	{
+		if (! empty($attributes['datetime_id'])) {
+			$datetime = EEM_Datetime::instance()->get_one_by_ID($attributes['datetime_id']);
+			if ($datetime instanceof EE_Datetime) {
+				return $datetime;
+			}
+		}
+		return null;
+	}
 
 
-    /**
-     * @param array $attributes
-     * @return EE_Base_Class|EE_Ticket|null
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    private function getTicket(array $attributes)
-    {
-        if (! empty($attributes['ticket_id'])) {
-            $ticket = EEM_Ticket::instance()->get_one_by_ID($attributes['ticket_id']);
-            if ($ticket instanceof EE_Ticket) {
-                return $ticket;
-            }
-        }
-        return null;
-    }
+	/**
+	 * @param array $attributes
+	 * @return EE_Base_Class|EE_Ticket|null
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	private function getTicket(array $attributes)
+	{
+		if (! empty($attributes['ticket_id'])) {
+			$ticket = EEM_Ticket::instance()->get_one_by_ID($attributes['ticket_id']);
+			if ($ticket instanceof EE_Ticket) {
+				return $ticket;
+			}
+		}
+		return null;
+	}
 
 
-    /**
-     * @param array $attributes
-     * @throws EE_Error
-     */
-    private function setAdditionalQueryParams(array $attributes)
-    {
-        $reg_status_array = EEM_Registration::reg_status_array();
-        if (isset($reg_status_array[ $attributes['status'] ])) {
-            $this->query_params[0]['Registration.STS_ID'] = $attributes['status'];
-        }
-        if (absint($attributes['limit'])) {
-            $this->query_params['limit'] = $attributes['limit'];
-        }
-        $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')
-        );
-    }
+	/**
+	 * @param array $attributes
+	 * @throws EE_Error
+	 */
+	private function setAdditionalQueryParams(array $attributes)
+	{
+		$reg_status_array = EEM_Registration::reg_status_array();
+		if (isset($reg_status_array[ $attributes['status'] ])) {
+			$this->query_params[0]['Registration.STS_ID'] = $attributes['status'];
+		}
+		if (absint($attributes['limit'])) {
+			$this->query_params['limit'] = $attributes['limit'];
+		}
+		$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/domain/entities/shortcodes/EspressoEvents.php

Indentation +117 added lines, -117 removed lines

@@ -30,131 +30,131 @@
  */
 class EspressoEvents extends EspressoShortcode
 {
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_EVENTS';
-    }
+	/**
+	 * 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 0;
-    }
+	/**
+	 * 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
-     * @throws ReflectionException
-     */
-    public function initializeShortcode()
-    {
-        EED_Events_Archive::instance()->event_list();
-        $this->shortcodeHasBeenInitialized();
-    }
+	/**
+	 * 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
+	 * @throws ReflectionException
+	 */
+	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|string $attributes
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function processShortcode($attributes = array())
-    {
-        // grab attributes and merge with defaults
-        $attributes = $this->getAttributes((array) $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');
-        // now reset the query and post data
-        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;
-    }
+	/**
+	 * 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|string $attributes
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function processShortcode($attributes = array())
+	{
+		// grab attributes and merge with defaults
+		$attributes = $this->getAttributes((array) $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');
+		// now reset the query and post data
+		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): array
-    {
-        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
-        );
-    }
+	/**
+	 * merge incoming attributes with filtered defaults
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function getAttributes(array $attributes): array
+	{
+		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(): array
-    {
-        // 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',
-        );
-    }
+	/**
+	 * 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(): array
+	{
+		// 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',
+		);
+	}
 }