eventespresso / event-espresso-core

core/espresso_definitions.php

Indentation +7 added lines, -7 removed lines

@@ -7,16 +7,16 @@ 
 define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
 // used to be DIRECTORY_SEPARATOR, but that caused issues on windows
 if (! defined('DS')) {
-    define('DS', '/');
+	define('DS', '/');
 }
 if (! defined('PS')) {
-    define('PS', PATH_SEPARATOR);
+	define('PS', PATH_SEPARATOR);
 }
 if (! defined('SP')) {
-    define('SP', ' ');
+	define('SP', ' ');
 }
 if (! defined('EENL')) {
-    define('EENL', "\n");
+	define('EENL', "\n");
 }
 // define the plugin directory and URL
 define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
@@ -70,7 +70,7 @@ 
 define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages/');
 // check for DOMPDF fonts in uploads
 if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts/')) {
-    define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts/');
+	define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts/');
 }
 // just a handy constant occasionally needed for finding values representing infinity in the DB
 // you're better to use this than its straight value (currently -1) in case you ever
@@ -78,9 +78,9 @@ 
 define('EE_INF_IN_DB', -1);
 define('EE_INF', INF > (float) PHP_INT_MAX ? INF : PHP_INT_MAX);
 if (! defined('EE_DEBUG')) {
-    define('EE_DEBUG', false);
+	define('EE_DEBUG', false);
 }
 // for older WP versions
 if (! defined('MONTH_IN_SECONDS')) {
-    define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
+	define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
 }

Spacing +45 added lines, -45 removed lines

@@ -6,81 +6,81 @@
 define('EE_MIN_PHP_VER_RECOMMENDED', '5.6.32');
 define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
 // used to be DIRECTORY_SEPARATOR, but that caused issues on windows
-if (! defined('DS')) {
+if ( ! defined('DS')) {
     define('DS', '/');
 }
-if (! defined('PS')) {
+if ( ! defined('PS')) {
     define('PS', PATH_SEPARATOR);
 }
-if (! defined('SP')) {
+if ( ! defined('SP')) {
     define('SP', ' ');
 }
-if (! defined('EENL')) {
+if ( ! defined('EENL')) {
     define('EENL', "\n");
 }
 // define the plugin directory and URL
 define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
-define('EE_PLUGIN_DIR_PATH', dirname(EVENT_ESPRESSO_MAIN_FILE) . '/');
+define('EE_PLUGIN_DIR_PATH', dirname(EVENT_ESPRESSO_MAIN_FILE).'/');
 define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
 // main root folder paths
-define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages/');
-define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core/');
-define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules/');
-define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public/');
-define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes/');
-define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets/');
-define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods/');
-define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated/');
+define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH.'admin_pages/');
+define('EE_CORE', EE_PLUGIN_DIR_PATH.'core/');
+define('EE_MODULES', EE_PLUGIN_DIR_PATH.'modules/');
+define('EE_PUBLIC', EE_PLUGIN_DIR_PATH.'public/');
+define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH.'shortcodes/');
+define('EE_WIDGETS', EE_PLUGIN_DIR_PATH.'widgets/');
+define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH.'payment_methods/');
+define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH.'caffeinated/');
 // core system paths
-define('EE_ADMIN', EE_CORE . 'admin/');
-define('EE_CPTS', EE_CORE . 'CPTs/');
-define('EE_CLASSES', EE_CORE . 'db_classes/');
-define('EE_INTERFACES', EE_CORE . 'interfaces/');
-define('EE_BUSINESS', EE_CORE . 'business/');
-define('EE_MODELS', EE_CORE . 'db_models/');
-define('EE_HELPERS', EE_CORE . 'helpers/');
-define('EE_LIBRARIES', EE_CORE . 'libraries/');
-define('EE_TEMPLATES', EE_CORE . 'templates/');
-define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs/');
-define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets/');
-define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections/');
+define('EE_ADMIN', EE_CORE.'admin/');
+define('EE_CPTS', EE_CORE.'CPTs/');
+define('EE_CLASSES', EE_CORE.'db_classes/');
+define('EE_INTERFACES', EE_CORE.'interfaces/');
+define('EE_BUSINESS', EE_CORE.'business/');
+define('EE_MODELS', EE_CORE.'db_models/');
+define('EE_HELPERS', EE_CORE.'helpers/');
+define('EE_LIBRARIES', EE_CORE.'libraries/');
+define('EE_TEMPLATES', EE_CORE.'templates/');
+define('EE_THIRD_PARTY', EE_CORE.'third_party_libs/');
+define('EE_GLOBAL_ASSETS', EE_TEMPLATES.'global_assets/');
+define('EE_FORM_SECTIONS', EE_LIBRARIES.'form_sections/');
 // gateways
-define('EE_GATEWAYS', EE_MODULES . 'gateways/');
-define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules/gateways/');
+define('EE_GATEWAYS', EE_MODULES.'gateways/');
+define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL.'modules/gateways/');
 // asset URL paths
-define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core/templates/');
-define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets/');
-define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images/');
-define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core/third_party_libs/');
-define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
-define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
+define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL.'core/templates/');
+define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL.'global_assets/');
+define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL.'images/');
+define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL.'core/third_party_libs/');
+define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL.'core/helpers/assets/');
+define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL.'core/libraries/');
 // define upload paths
 $uploads = wp_upload_dir();
 // define the uploads directory and URL
-define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . '/espresso/');
-define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . '/espresso/');
+define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'].'/espresso/');
+define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'].'/espresso/');
 // define the templates directory and URL
-define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . '/espresso/templates/');
-define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . '/espresso/templates/');
+define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'].'/espresso/templates/');
+define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'].'/espresso/templates/');
 // define the gateway directory and URL
-define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . '/espresso/gateways/');
-define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . '/espresso/gateways/');
+define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'].'/espresso/gateways/');
+define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'].'/espresso/gateways/');
 // languages folder/path
-define('EE_LANGUAGES_SAFE_LOC', '../' . 'uploads/' . 'espresso/languages/');
-define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages/');
+define('EE_LANGUAGES_SAFE_LOC', '../'.'uploads/'.'espresso/languages/');
+define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR.'languages/');
 // check for DOMPDF fonts in uploads
-if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts/')) {
-    define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts/');
+if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR.'fonts/')) {
+    define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR.'fonts/');
 }
 // just a handy constant occasionally needed for finding values representing infinity in the DB
 // you're better to use this than its straight value (currently -1) in case you ever
 // want to change its default value! or find when -1 means infinity
 define('EE_INF_IN_DB', -1);
 define('EE_INF', INF > (float) PHP_INT_MAX ? INF : PHP_INT_MAX);
-if (! defined('EE_DEBUG')) {
+if ( ! defined('EE_DEBUG')) {
     define('EE_DEBUG', false);
 }
 // for older WP versions
-if (! defined('MONTH_IN_SECONDS')) {
+if ( ! defined('MONTH_IN_SECONDS')) {
     define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
 }

core/domain/services/contexts/RequestTypeContextDetector.php

Indentation +198 added lines, -198 removed lines

@@ -18,202 +18,202 @@
 class RequestTypeContextDetector
 {
 
-    /**
-     * @var RequestTypeContextFactoryInterface $factory
-     */
-    private $factory;
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-    /**
-     * @var array $globalRouteConditions
-     */
-    private $globalRouteConditions;
-
-
-    /**
-     * RequestTypeContextDetector constructor.
-     *
-     * @param RequestInterface                   $request
-     * @param RequestTypeContextFactoryInterface $factory
-     * @param array                              $globalRouteConditions an array for injecting values that would
-     *                                                                  otherwise be defined as global constants
-     *                                                                  or other global variables for the current
-     *                                                                  request route such as DOING_AJAX
-     */
-    public function __construct(
-        RequestInterface $request,
-        RequestTypeContextFactoryInterface $factory,
-        array $globalRouteConditions = array()
-    ) {
-        $this->request = $request;
-        $this->factory = $factory;
-        $this->globalRouteConditions = $globalRouteConditions;
-    }
-
-
-    /**
-     * @return mixed
-     */
-    private function getGlobalRouteCondition($globalRouteCondition, $default)
-    {
-        return isset($this->globalRouteConditions[ $globalRouteCondition ])
-            ? $this->globalRouteConditions[ $globalRouteCondition ]
-            : $default;
-    }
-
-
-    /**
-     * @return RequestTypeContext
-     * @throws InvalidArgumentException
-     */
-    public function detectRequestTypeContext()
-    {
-        // Detect error scrapes
-        if ($this->request->getRequestParam('wp_scrape_key')
-            && $this->request->getRequestParam('wp_scrape_nonce')
-        ) {
-            return $this->factory->create(RequestTypeContext::WP_SCRAPE);
-        }
-        // Detect EE REST API
-        if ($this->isEspressoRestApiRequest()) {
-            return $this->factory->create(RequestTypeContext::API);
-        }
-        // Detect WP REST API
-        if ($this->isWordPressRestApiRequest()) {
-            return $this->factory->create(RequestTypeContext::WP_API);
-        }
-        // Detect AJAX
-        if ($this->getGlobalRouteCondition('DOING_AJAX', false)) {
-            return $this->isAjaxRequest();
-        }
-        // Detect WP_Cron
-        if ($this->isCronRequest()) {
-            return $this->factory->create(RequestTypeContext::CRON);
-        }
-        // Detect command line requests
-        if ($this->getGlobalRouteCondition('WP_CLI', false)) {
-            return $this->factory->create(RequestTypeContext::CLI);
-        }
-        // detect WordPress admin (ie: "Dashboard")
-        if ($this->getGlobalRouteCondition('is_admin', false)) {
-            return $this->factory->create(RequestTypeContext::ADMIN);
-        }
-        // Detect iFrames
-        if ($this->isIframeRoute()) {
-            return $this->factory->create(RequestTypeContext::IFRAME);
-        }
-        // Detect Feeds
-        if ($this->isFeedRequest()) {
-            return $this->factory->create(RequestTypeContext::FEED);
-        }
-        // and by process of elimination...
-        return $this->factory->create(RequestTypeContext::FRONTEND);
-    }
-
-
-    /**
-     * @return RequestTypeContext
-     */
-    private function isAjaxRequest()
-    {
-        if (
-            $this->request->getRequestParam('ee_front_ajax', 0, 'int')
-            || $this->request->getRequestParam('data[ee_front_ajax]', 0, 'int')
-        ) {
-            if (! defined('EE_FRONT_AJAX')) {
-                define( 'EE_FRONT_AJAX', true);
-            }
-            return $this->factory->create(RequestTypeContext::AJAX_FRONT);
-        }
-        if (
-            $this->request->getRequestParam('ee_admin_ajax', 0, 'int')
-            || $this->request->getRequestParam('data[ee_admin_ajax]', 0, 'int')
-        ) {
-            if (! defined('EE_ADMIN_AJAX')) {
-                define('EE_ADMIN_AJAX', true);
-            }
-            return $this->factory->create(RequestTypeContext::AJAX_ADMIN);
-        }
-        if ($this->request->getRequestParam('action') === 'heartbeat') {
-            return $this->factory->create(RequestTypeContext::AJAX_HEARTBEAT);
-        }
-        return $this->factory->create(RequestTypeContext::AJAX_OTHER);
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function isEspressoRestApiRequest()
-    {
-        // Check for URLs like http://mysite.com/?rest_route=/ee... and http://mysite.com/wp-json/ee/...
-        return strpos(
-            $this->request->getRequestParam('rest_route'),
-            '/' . Domain::API_NAMESPACE
-        ) === 0
-            || $this->uriPathMatches(trim(rest_get_url_prefix(), '/') . '/' . Domain::API_NAMESPACE);
-    }
-
-
-
-    /**
-     * @return bool
-     */
-    private function isWordPressRestApiRequest()
-    {
-        // Check for URLs like http://mysite.com/?rest_route=/.. and http://mysite.com/wp-json/...
-        return $this->request->getRequestParam('rest_route') !== ''
-            || $this->uriPathMatches(trim(rest_get_url_prefix(), '/'));
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function isCronRequest()
-    {
-        return $this->uriPathMatches('wp-cron.php');
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function isFeedRequest()
-    {
-        return $this->uriPathMatches('feed');
-    }
-
-
-    /**
-     * @param string $component
-     * @return bool
-     */
-    private function uriPathMatches($component)
-    {
-        $request_uri = $this->request->requestUri(true);
-        $parts = explode('?', $request_uri);
-        $path = trim(reset($parts), '/');
-        return strpos($path, $component) === 0;
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function isIframeRoute()
-    {
-        $is_iframe_route = apply_filters(
-            'FHEE__EventEspresso_core_domain_services_contexts_RequestTypeContextDetector__isIframeRoute',
-            $this->request->getRequestParam('event_list', '') === 'iframe'
-            || $this->request->getRequestParam('ticket_selector', '') === 'iframe'
-            || $this->request->getRequestParam('calendar', '') === 'iframe',
-            $this
-        );
-        return filter_var($is_iframe_route, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * @var RequestTypeContextFactoryInterface $factory
+	 */
+	private $factory;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+	/**
+	 * @var array $globalRouteConditions
+	 */
+	private $globalRouteConditions;
+
+
+	/**
+	 * RequestTypeContextDetector constructor.
+	 *
+	 * @param RequestInterface                   $request
+	 * @param RequestTypeContextFactoryInterface $factory
+	 * @param array                              $globalRouteConditions an array for injecting values that would
+	 *                                                                  otherwise be defined as global constants
+	 *                                                                  or other global variables for the current
+	 *                                                                  request route such as DOING_AJAX
+	 */
+	public function __construct(
+		RequestInterface $request,
+		RequestTypeContextFactoryInterface $factory,
+		array $globalRouteConditions = array()
+	) {
+		$this->request = $request;
+		$this->factory = $factory;
+		$this->globalRouteConditions = $globalRouteConditions;
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	private function getGlobalRouteCondition($globalRouteCondition, $default)
+	{
+		return isset($this->globalRouteConditions[ $globalRouteCondition ])
+			? $this->globalRouteConditions[ $globalRouteCondition ]
+			: $default;
+	}
+
+
+	/**
+	 * @return RequestTypeContext
+	 * @throws InvalidArgumentException
+	 */
+	public function detectRequestTypeContext()
+	{
+		// Detect error scrapes
+		if ($this->request->getRequestParam('wp_scrape_key')
+			&& $this->request->getRequestParam('wp_scrape_nonce')
+		) {
+			return $this->factory->create(RequestTypeContext::WP_SCRAPE);
+		}
+		// Detect EE REST API
+		if ($this->isEspressoRestApiRequest()) {
+			return $this->factory->create(RequestTypeContext::API);
+		}
+		// Detect WP REST API
+		if ($this->isWordPressRestApiRequest()) {
+			return $this->factory->create(RequestTypeContext::WP_API);
+		}
+		// Detect AJAX
+		if ($this->getGlobalRouteCondition('DOING_AJAX', false)) {
+			return $this->isAjaxRequest();
+		}
+		// Detect WP_Cron
+		if ($this->isCronRequest()) {
+			return $this->factory->create(RequestTypeContext::CRON);
+		}
+		// Detect command line requests
+		if ($this->getGlobalRouteCondition('WP_CLI', false)) {
+			return $this->factory->create(RequestTypeContext::CLI);
+		}
+		// detect WordPress admin (ie: "Dashboard")
+		if ($this->getGlobalRouteCondition('is_admin', false)) {
+			return $this->factory->create(RequestTypeContext::ADMIN);
+		}
+		// Detect iFrames
+		if ($this->isIframeRoute()) {
+			return $this->factory->create(RequestTypeContext::IFRAME);
+		}
+		// Detect Feeds
+		if ($this->isFeedRequest()) {
+			return $this->factory->create(RequestTypeContext::FEED);
+		}
+		// and by process of elimination...
+		return $this->factory->create(RequestTypeContext::FRONTEND);
+	}
+
+
+	/**
+	 * @return RequestTypeContext
+	 */
+	private function isAjaxRequest()
+	{
+		if (
+			$this->request->getRequestParam('ee_front_ajax', 0, 'int')
+			|| $this->request->getRequestParam('data[ee_front_ajax]', 0, 'int')
+		) {
+			if (! defined('EE_FRONT_AJAX')) {
+				define( 'EE_FRONT_AJAX', true);
+			}
+			return $this->factory->create(RequestTypeContext::AJAX_FRONT);
+		}
+		if (
+			$this->request->getRequestParam('ee_admin_ajax', 0, 'int')
+			|| $this->request->getRequestParam('data[ee_admin_ajax]', 0, 'int')
+		) {
+			if (! defined('EE_ADMIN_AJAX')) {
+				define('EE_ADMIN_AJAX', true);
+			}
+			return $this->factory->create(RequestTypeContext::AJAX_ADMIN);
+		}
+		if ($this->request->getRequestParam('action') === 'heartbeat') {
+			return $this->factory->create(RequestTypeContext::AJAX_HEARTBEAT);
+		}
+		return $this->factory->create(RequestTypeContext::AJAX_OTHER);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function isEspressoRestApiRequest()
+	{
+		// Check for URLs like http://mysite.com/?rest_route=/ee... and http://mysite.com/wp-json/ee/...
+		return strpos(
+			$this->request->getRequestParam('rest_route'),
+			'/' . Domain::API_NAMESPACE
+		) === 0
+			|| $this->uriPathMatches(trim(rest_get_url_prefix(), '/') . '/' . Domain::API_NAMESPACE);
+	}
+
+
+
+	/**
+	 * @return bool
+	 */
+	private function isWordPressRestApiRequest()
+	{
+		// Check for URLs like http://mysite.com/?rest_route=/.. and http://mysite.com/wp-json/...
+		return $this->request->getRequestParam('rest_route') !== ''
+			|| $this->uriPathMatches(trim(rest_get_url_prefix(), '/'));
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function isCronRequest()
+	{
+		return $this->uriPathMatches('wp-cron.php');
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function isFeedRequest()
+	{
+		return $this->uriPathMatches('feed');
+	}
+
+
+	/**
+	 * @param string $component
+	 * @return bool
+	 */
+	private function uriPathMatches($component)
+	{
+		$request_uri = $this->request->requestUri(true);
+		$parts = explode('?', $request_uri);
+		$path = trim(reset($parts), '/');
+		return strpos($path, $component) === 0;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function isIframeRoute()
+	{
+		$is_iframe_route = apply_filters(
+			'FHEE__EventEspresso_core_domain_services_contexts_RequestTypeContextDetector__isIframeRoute',
+			$this->request->getRequestParam('event_list', '') === 'iframe'
+			|| $this->request->getRequestParam('ticket_selector', '') === 'iframe'
+			|| $this->request->getRequestParam('calendar', '') === 'iframe',
+			$this
+		);
+		return filter_var($is_iframe_route, FILTER_VALIDATE_BOOLEAN);
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -60,8 +60,8 @@ 
      */
     private function getGlobalRouteCondition($globalRouteCondition, $default)
     {
-        return isset($this->globalRouteConditions[ $globalRouteCondition ])
-            ? $this->globalRouteConditions[ $globalRouteCondition ]
+        return isset($this->globalRouteConditions[$globalRouteCondition])
+            ? $this->globalRouteConditions[$globalRouteCondition]
             : $default;
     }
 
@@ -124,8 +124,8 @@ 
             $this->request->getRequestParam('ee_front_ajax', 0, 'int')
             || $this->request->getRequestParam('data[ee_front_ajax]', 0, 'int')
         ) {
-            if (! defined('EE_FRONT_AJAX')) {
-                define( 'EE_FRONT_AJAX', true);
+            if ( ! defined('EE_FRONT_AJAX')) {
+                define('EE_FRONT_AJAX', true);
             }
             return $this->factory->create(RequestTypeContext::AJAX_FRONT);
         }
@@ -133,7 +133,7 @@ 
             $this->request->getRequestParam('ee_admin_ajax', 0, 'int')
             || $this->request->getRequestParam('data[ee_admin_ajax]', 0, 'int')
         ) {
-            if (! defined('EE_ADMIN_AJAX')) {
+            if ( ! defined('EE_ADMIN_AJAX')) {
                 define('EE_ADMIN_AJAX', true);
             }
             return $this->factory->create(RequestTypeContext::AJAX_ADMIN);
@@ -153,9 +153,9 @@ 
         // Check for URLs like http://mysite.com/?rest_route=/ee... and http://mysite.com/wp-json/ee/...
         return strpos(
             $this->request->getRequestParam('rest_route'),
-            '/' . Domain::API_NAMESPACE
+            '/'.Domain::API_NAMESPACE
         ) === 0
-            || $this->uriPathMatches(trim(rest_get_url_prefix(), '/') . '/' . Domain::API_NAMESPACE);
+            || $this->uriPathMatches(trim(rest_get_url_prefix(), '/').'/'.Domain::API_NAMESPACE);
     }
 
 

core/domain/services/admin/registrations/list_table/QueryBuilder.php

Indentation +378 added lines, -378 removed lines

@@ -21,382 +21,382 @@
 class QueryBuilder
 {
 
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-    /**
-     * @var EEM_Registration $registration_model
-     */
-    protected $registration_model;
-
-    /**
-     * @var string $view
-     */
-    protected $view;
-
-    /**
-     * @var array $where_params
-     */
-    protected $where_params;
-
-
-    /**
-     * QueryBuilder constructor.
-     *
-     * @param RequestInterface $request
-     * @param EEM_Registration $registration_model
-     * @param array            $extra_request_params
-     */
-    public function __construct(
-        RequestInterface $request,
-        EEM_Registration $registration_model,
-        array $extra_request_params = []
-    ) {
-        $this->request = $request;
-        $this->registration_model = $registration_model;
-        foreach ($extra_request_params as $key => $value) {
-            $this->request->setRequestParam($key, $value);
-        }
-        $this->view = $this->request->getRequestParam('status', '');
-        $this->where_params = [];
-    }
-
-
-    /**
-     * Sets up the where conditions for the registrations query.
-     *
-     * @param int  $per_page
-     * @param bool $count_query
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function getQueryParams($per_page = 10, $count_query = false)
-    {
-        $query_params = [
-            0                          => $this->getWhereClause(),
-            'caps'                     => EEM_Registration::caps_read_admin,
-            'default_where_conditions' => 'this_model_only',
-        ];
-        if (! $count_query) {
-            $query_params = array_merge(
-                $query_params,
-                $this->getOrderbyClause(),
-                $this->getLimitClause($per_page)
-            );
-        }
-
-        return $query_params;
-    }
-
-
-    /**
-     * Sets up the where conditions for the registrations query.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getWhereClause()
-    {
-        $this->addAttendeeIdToWhereConditions();
-        $this->addEventIdToWhereConditions();
-        $this->addCategoryIdToWhereConditions();
-        $this->addDatetimeIdToWhereConditions();
-        $this->addTicketIdToWhereConditions();
-        $this->addRegistrationStatusToWhereConditions();
-        $this->addDateToWhereConditions();
-        $this->addSearchToWhereConditions();
-        return apply_filters(
-            'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query',
-            $this->where_params,
-            $this->request->requestParams()
-        );
-    }
-
-
-    /**
-     * This will add ATT_ID to the provided $this->where_clause array for EE model query parameters.
-     */
-    protected function addAttendeeIdToWhereConditions()
-    {
-        $ATT_ID = $this->request->getRequestParam('attendee_id');
-        $ATT_ID = $this->request->getRequestParam('ATT_ID', $ATT_ID, 'int');
-        if ($ATT_ID) {
-            $this->where_params['ATT_ID'] = $ATT_ID;
-        }
-    }
-
-
-    /**
-     * This will add EVT_ID to the provided $this->where_clause array for EE model query parameters.
-     */
-    protected function addEventIdToWhereConditions()
-    {
-        $EVT_ID = $this->request->getRequestParam('event_id');
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', $EVT_ID, 'int');
-        if ($EVT_ID) {
-            $this->where_params['EVT_ID'] = $EVT_ID;
-        }
-    }
-
-
-    /**
-     * Adds category ID if it exists in the request to the where conditions for the registrations query.
-     */
-    protected function addCategoryIdToWhereConditions()
-    {
-        $EVT_CAT = (int) $this->request->getRequestParam('EVT_CAT', 0, 'int');
-        if ($EVT_CAT > 0) {
-            $this->where_params['Event.Term_Taxonomy.term_id'] = $EVT_CAT;
-        }
-    }
-
-
-    /**
-     * Adds the datetime ID if it exists in the request to the where conditions for the registrations query.
-     */
-    protected function addDatetimeIdToWhereConditions()
-    {
-        // first look for 'datetime_id' then 'DTT_ID' using first result as fallback default value
-        $DTT_ID = $this->request->getRequestParam('datetime_id');
-        $DTT_ID = $this->request->getRequestParam('DTT_ID', $DTT_ID, 'int');
-        if ($DTT_ID) {
-            $this->where_params['Ticket.Datetime.DTT_ID'] = $DTT_ID;
-        }
-    }
-
-
-    /**
-     * Adds the ticket ID if it exists in the request to the where conditions for the registrations query.
-     */
-    protected function addTicketIdToWhereConditions()
-    {
-        // first look for 'ticket_id' then 'TKT_ID' using first result as fallback default value
-        $TKT_ID = $this->request->getRequestParam('ticket_id');
-        $TKT_ID = $this->request->getRequestParam('TKT_ID', $TKT_ID, 'int');
-        if ($TKT_ID) {
-            $this->where_params['TKT_ID'] = $TKT_ID;
-        }
-    }
-
-
-    /**
-     * Adds the correct registration status to the where conditions for the registrations query.
-     * If filtering by registration status, then we show registrations matching that status.
-     * If not filtering by specified status, then we show all registrations excluding incomplete registrations
-     * UNLESS viewing trashed registrations.
-     */
-    protected function addRegistrationStatusToWhereConditions()
-    {
-        $registration_status = $this->request->getRequestParam('_reg_status');
-        if ($registration_status) {
-            $this->where_params['STS_ID'] = sanitize_text_field($registration_status);
-            return;
-        }
-        // make sure we exclude incomplete registrations, but only if not trashed.
-        if ($this->view === 'trash') {
-            $this->where_params['REG_deleted'] = true;
-            return;
-        }
-        $this->where_params['STS_ID'] = $this->view === 'incomplete'
-            ? EEM_Registration::status_id_incomplete
-            : ['!=', EEM_Registration::status_id_incomplete];
-    }
-
-
-    /**
-     * Adds any provided date restraints to the where conditions for the registrations query.
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function addDateToWhereConditions()
-    {
-        if ($this->view === 'today') {
-            $now = date('Y-m-d', current_time('timestamp'));
-            $this->where_params['REG_date'] = [
-                'BETWEEN',
-                [
-                    $this->registration_model->convert_datetime_for_query(
-                        'REG_date',
-                        $now . ' 00:00:00',
-                        'Y-m-d H:i:s'
-                    ),
-                    $this->registration_model->convert_datetime_for_query(
-                        'REG_date',
-                        $now . ' 23:59:59',
-                        'Y-m-d H:i:s'
-                    ),
-                ],
-            ];
-            return;
-        }
-        if ($this->view === 'month') {
-            $current_year_and_month = date('Y-m', current_time('timestamp'));
-            $days_this_month = date('t', current_time('timestamp'));
-            $this->where_params['REG_date'] = [
-                'BETWEEN',
-                [
-                    $this->registration_model->convert_datetime_for_query(
-                        'REG_date',
-                        $current_year_and_month . '-01 00:00:00',
-                        'Y-m-d H:i:s'
-                    ),
-                    $this->registration_model->convert_datetime_for_query(
-                        'REG_date',
-                        $current_year_and_month . '-' . $days_this_month . ' 23:59:59',
-                        'Y-m-d H:i:s'
-                    ),
-                ],
-            ];
-            return;
-        }
-        $month_range = $this->request->getRequestParam('month_range');
-        if ($month_range) {
-            $month_range = sanitize_text_field($month_range);
-            $pieces = explode(' ', $month_range, 3);
-            $month_requested = ! empty($pieces[0])
-                ? date('m', EEH_DTT_Helper::first_of_month_timestamp($pieces[0]))
-                : '';
-            $year_requested = ! empty($pieces[1])
-                ? $pieces[1]
-                : '';
-            // if there is not a month or year then we can't go further
-            if ($month_requested && $year_requested) {
-                $days_in_month = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
-                $this->where_params['REG_date'] = [
-                    'BETWEEN',
-                    [
-                        $this->registration_model->convert_datetime_for_query(
-                            'REG_date',
-                            $year_requested . '-' . $month_requested . '-01 00:00:00',
-                            'Y-m-d H:i:s'
-                        ),
-                        $this->registration_model->convert_datetime_for_query(
-                            'REG_date',
-                            $year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
-                            'Y-m-d H:i:s'
-                        ),
-                    ],
-                ];
-            }
-        }
-    }
-
-
-    /**
-     * Adds any provided search restraints to the where conditions for the registrations query
-     */
-    protected function addSearchToWhereConditions()
-    {
-        $search = $this->request->getRequestParam('s');
-        if ($search) {
-            $search_string = '%' . sanitize_text_field($search) . '%';
-            $this->where_params['OR*search_conditions'] = [
-                'Event.EVT_name'                          => ['LIKE', $search_string],
-                'Event.EVT_desc'                          => ['LIKE', $search_string],
-                'Event.EVT_short_desc'                    => ['LIKE', $search_string],
-                'Attendee.ATT_full_name'                  => ['LIKE', $search_string],
-                'Attendee.ATT_fname'                      => ['LIKE', $search_string],
-                'Attendee.ATT_lname'                      => ['LIKE', $search_string],
-                'Attendee.ATT_short_bio'                  => ['LIKE', $search_string],
-                'Attendee.ATT_email'                      => ['LIKE', $search_string],
-                'Attendee.ATT_address'                    => ['LIKE', $search_string],
-                'Attendee.ATT_address2'                   => ['LIKE', $search_string],
-                'Attendee.ATT_city'                       => ['LIKE', $search_string],
-                'REG_final_price'                         => ['LIKE', $search_string],
-                'REG_code'                                => ['LIKE', $search_string],
-                'REG_count'                               => ['LIKE', $search_string],
-                'REG_group_size'                          => ['LIKE', $search_string],
-                'Ticket.TKT_name'                         => ['LIKE', $search_string],
-                'Ticket.TKT_description'                  => ['LIKE', $search_string],
-                'Transaction.Payment.PAY_txn_id_chq_nmbr' => ['LIKE', $search_string],
-            ];
-        }
-    }
-
-
-    /**
-     * Sets up the orderby for the registrations query.
-     *
-     * @return array
-     */
-    protected function getOrderbyClause()
-    {
-        $orderby_field = $this->request->getRequestParam('orderby');
-        $orderby_field = $orderby_field ? sanitize_text_field($orderby_field) : '_REG_date';
-        switch ($orderby_field) {
-            case '_REG_ID':
-                $orderby = ['REG_ID'];
-                break;
-            case '_Reg_status':
-                $orderby = ['STS_ID'];
-                break;
-            case 'ATT_fname':
-                $orderby = ['Attendee.ATT_fname', 'Attendee.ATT_lname'];
-                break;
-            case 'ATT_lname':
-                $orderby = ['Attendee.ATT_lname', 'Attendee.ATT_fname'];
-                break;
-            case 'event_name':
-                $orderby = ['Event.EVT_name'];
-                break;
-            case 'DTT_EVT_start':
-                $orderby = ['Event.Datetime.DTT_EVT_start'];
-                break;
-            case '_REG_date':
-                $orderby = ['REG_date'];
-                break;
-            default:
-                $orderby = [$orderby_field];
-                break;
-        }
-        $order = $this->request->getRequestParam('order');
-        $order = $order ? sanitize_text_field($order) : 'DESC';
-
-        $orderby = array_combine(
-            $orderby,
-            array_fill(0, count($orderby), $order)
-        );
-        // because there are many registrations with the same date, define
-        // a secondary way to order them, otherwise MySQL seems to be a bit random
-        if (empty($orderby['REG_ID'])) {
-            $orderby['REG_ID'] = $order;
-        }
-
-        $orderby = apply_filters(
-            'FHEE__Registrations_Admin_Page___get_orderby_for_registrations_query',
-            $orderby,
-            $this->request->requestParams()
-        );
-        return ['order_by' => $orderby];
-    }
-
-
-    /**
-     * Sets up the limit for the registrations query.
-     *
-     * @param $per_page
-     * @return array
-     */
-    protected function getLimitClause($per_page)
-    {
-        $current_page = $this->request->getRequestParam('paged', 1, 'int');
-        $per_page = $this->request->getRequestParam('perpage', $per_page, 'int');
-        // -1 means return all results so get out if that's set.
-        if ($per_page === -1) {
-            return [];
-        }
-        $offset = ($current_page - 1) * $per_page;
-        return ['limit' => [$offset, $per_page]];
-    }
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+	/**
+	 * @var EEM_Registration $registration_model
+	 */
+	protected $registration_model;
+
+	/**
+	 * @var string $view
+	 */
+	protected $view;
+
+	/**
+	 * @var array $where_params
+	 */
+	protected $where_params;
+
+
+	/**
+	 * QueryBuilder constructor.
+	 *
+	 * @param RequestInterface $request
+	 * @param EEM_Registration $registration_model
+	 * @param array            $extra_request_params
+	 */
+	public function __construct(
+		RequestInterface $request,
+		EEM_Registration $registration_model,
+		array $extra_request_params = []
+	) {
+		$this->request = $request;
+		$this->registration_model = $registration_model;
+		foreach ($extra_request_params as $key => $value) {
+			$this->request->setRequestParam($key, $value);
+		}
+		$this->view = $this->request->getRequestParam('status', '');
+		$this->where_params = [];
+	}
+
+
+	/**
+	 * Sets up the where conditions for the registrations query.
+	 *
+	 * @param int  $per_page
+	 * @param bool $count_query
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function getQueryParams($per_page = 10, $count_query = false)
+	{
+		$query_params = [
+			0                          => $this->getWhereClause(),
+			'caps'                     => EEM_Registration::caps_read_admin,
+			'default_where_conditions' => 'this_model_only',
+		];
+		if (! $count_query) {
+			$query_params = array_merge(
+				$query_params,
+				$this->getOrderbyClause(),
+				$this->getLimitClause($per_page)
+			);
+		}
+
+		return $query_params;
+	}
+
+
+	/**
+	 * Sets up the where conditions for the registrations query.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getWhereClause()
+	{
+		$this->addAttendeeIdToWhereConditions();
+		$this->addEventIdToWhereConditions();
+		$this->addCategoryIdToWhereConditions();
+		$this->addDatetimeIdToWhereConditions();
+		$this->addTicketIdToWhereConditions();
+		$this->addRegistrationStatusToWhereConditions();
+		$this->addDateToWhereConditions();
+		$this->addSearchToWhereConditions();
+		return apply_filters(
+			'FHEE__Registrations_Admin_Page___get_where_conditions_for_registrations_query',
+			$this->where_params,
+			$this->request->requestParams()
+		);
+	}
+
+
+	/**
+	 * This will add ATT_ID to the provided $this->where_clause array for EE model query parameters.
+	 */
+	protected function addAttendeeIdToWhereConditions()
+	{
+		$ATT_ID = $this->request->getRequestParam('attendee_id');
+		$ATT_ID = $this->request->getRequestParam('ATT_ID', $ATT_ID, 'int');
+		if ($ATT_ID) {
+			$this->where_params['ATT_ID'] = $ATT_ID;
+		}
+	}
+
+
+	/**
+	 * This will add EVT_ID to the provided $this->where_clause array for EE model query parameters.
+	 */
+	protected function addEventIdToWhereConditions()
+	{
+		$EVT_ID = $this->request->getRequestParam('event_id');
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', $EVT_ID, 'int');
+		if ($EVT_ID) {
+			$this->where_params['EVT_ID'] = $EVT_ID;
+		}
+	}
+
+
+	/**
+	 * Adds category ID if it exists in the request to the where conditions for the registrations query.
+	 */
+	protected function addCategoryIdToWhereConditions()
+	{
+		$EVT_CAT = (int) $this->request->getRequestParam('EVT_CAT', 0, 'int');
+		if ($EVT_CAT > 0) {
+			$this->where_params['Event.Term_Taxonomy.term_id'] = $EVT_CAT;
+		}
+	}
+
+
+	/**
+	 * Adds the datetime ID if it exists in the request to the where conditions for the registrations query.
+	 */
+	protected function addDatetimeIdToWhereConditions()
+	{
+		// first look for 'datetime_id' then 'DTT_ID' using first result as fallback default value
+		$DTT_ID = $this->request->getRequestParam('datetime_id');
+		$DTT_ID = $this->request->getRequestParam('DTT_ID', $DTT_ID, 'int');
+		if ($DTT_ID) {
+			$this->where_params['Ticket.Datetime.DTT_ID'] = $DTT_ID;
+		}
+	}
+
+
+	/**
+	 * Adds the ticket ID if it exists in the request to the where conditions for the registrations query.
+	 */
+	protected function addTicketIdToWhereConditions()
+	{
+		// first look for 'ticket_id' then 'TKT_ID' using first result as fallback default value
+		$TKT_ID = $this->request->getRequestParam('ticket_id');
+		$TKT_ID = $this->request->getRequestParam('TKT_ID', $TKT_ID, 'int');
+		if ($TKT_ID) {
+			$this->where_params['TKT_ID'] = $TKT_ID;
+		}
+	}
+
+
+	/**
+	 * Adds the correct registration status to the where conditions for the registrations query.
+	 * If filtering by registration status, then we show registrations matching that status.
+	 * If not filtering by specified status, then we show all registrations excluding incomplete registrations
+	 * UNLESS viewing trashed registrations.
+	 */
+	protected function addRegistrationStatusToWhereConditions()
+	{
+		$registration_status = $this->request->getRequestParam('_reg_status');
+		if ($registration_status) {
+			$this->where_params['STS_ID'] = sanitize_text_field($registration_status);
+			return;
+		}
+		// make sure we exclude incomplete registrations, but only if not trashed.
+		if ($this->view === 'trash') {
+			$this->where_params['REG_deleted'] = true;
+			return;
+		}
+		$this->where_params['STS_ID'] = $this->view === 'incomplete'
+			? EEM_Registration::status_id_incomplete
+			: ['!=', EEM_Registration::status_id_incomplete];
+	}
+
+
+	/**
+	 * Adds any provided date restraints to the where conditions for the registrations query.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function addDateToWhereConditions()
+	{
+		if ($this->view === 'today') {
+			$now = date('Y-m-d', current_time('timestamp'));
+			$this->where_params['REG_date'] = [
+				'BETWEEN',
+				[
+					$this->registration_model->convert_datetime_for_query(
+						'REG_date',
+						$now . ' 00:00:00',
+						'Y-m-d H:i:s'
+					),
+					$this->registration_model->convert_datetime_for_query(
+						'REG_date',
+						$now . ' 23:59:59',
+						'Y-m-d H:i:s'
+					),
+				],
+			];
+			return;
+		}
+		if ($this->view === 'month') {
+			$current_year_and_month = date('Y-m', current_time('timestamp'));
+			$days_this_month = date('t', current_time('timestamp'));
+			$this->where_params['REG_date'] = [
+				'BETWEEN',
+				[
+					$this->registration_model->convert_datetime_for_query(
+						'REG_date',
+						$current_year_and_month . '-01 00:00:00',
+						'Y-m-d H:i:s'
+					),
+					$this->registration_model->convert_datetime_for_query(
+						'REG_date',
+						$current_year_and_month . '-' . $days_this_month . ' 23:59:59',
+						'Y-m-d H:i:s'
+					),
+				],
+			];
+			return;
+		}
+		$month_range = $this->request->getRequestParam('month_range');
+		if ($month_range) {
+			$month_range = sanitize_text_field($month_range);
+			$pieces = explode(' ', $month_range, 3);
+			$month_requested = ! empty($pieces[0])
+				? date('m', EEH_DTT_Helper::first_of_month_timestamp($pieces[0]))
+				: '';
+			$year_requested = ! empty($pieces[1])
+				? $pieces[1]
+				: '';
+			// if there is not a month or year then we can't go further
+			if ($month_requested && $year_requested) {
+				$days_in_month = date('t', strtotime($year_requested . '-' . $month_requested . '-' . '01'));
+				$this->where_params['REG_date'] = [
+					'BETWEEN',
+					[
+						$this->registration_model->convert_datetime_for_query(
+							'REG_date',
+							$year_requested . '-' . $month_requested . '-01 00:00:00',
+							'Y-m-d H:i:s'
+						),
+						$this->registration_model->convert_datetime_for_query(
+							'REG_date',
+							$year_requested . '-' . $month_requested . '-' . $days_in_month . ' 23:59:59',
+							'Y-m-d H:i:s'
+						),
+					],
+				];
+			}
+		}
+	}
+
+
+	/**
+	 * Adds any provided search restraints to the where conditions for the registrations query
+	 */
+	protected function addSearchToWhereConditions()
+	{
+		$search = $this->request->getRequestParam('s');
+		if ($search) {
+			$search_string = '%' . sanitize_text_field($search) . '%';
+			$this->where_params['OR*search_conditions'] = [
+				'Event.EVT_name'                          => ['LIKE', $search_string],
+				'Event.EVT_desc'                          => ['LIKE', $search_string],
+				'Event.EVT_short_desc'                    => ['LIKE', $search_string],
+				'Attendee.ATT_full_name'                  => ['LIKE', $search_string],
+				'Attendee.ATT_fname'                      => ['LIKE', $search_string],
+				'Attendee.ATT_lname'                      => ['LIKE', $search_string],
+				'Attendee.ATT_short_bio'                  => ['LIKE', $search_string],
+				'Attendee.ATT_email'                      => ['LIKE', $search_string],
+				'Attendee.ATT_address'                    => ['LIKE', $search_string],
+				'Attendee.ATT_address2'                   => ['LIKE', $search_string],
+				'Attendee.ATT_city'                       => ['LIKE', $search_string],
+				'REG_final_price'                         => ['LIKE', $search_string],
+				'REG_code'                                => ['LIKE', $search_string],
+				'REG_count'                               => ['LIKE', $search_string],
+				'REG_group_size'                          => ['LIKE', $search_string],
+				'Ticket.TKT_name'                         => ['LIKE', $search_string],
+				'Ticket.TKT_description'                  => ['LIKE', $search_string],
+				'Transaction.Payment.PAY_txn_id_chq_nmbr' => ['LIKE', $search_string],
+			];
+		}
+	}
+
+
+	/**
+	 * Sets up the orderby for the registrations query.
+	 *
+	 * @return array
+	 */
+	protected function getOrderbyClause()
+	{
+		$orderby_field = $this->request->getRequestParam('orderby');
+		$orderby_field = $orderby_field ? sanitize_text_field($orderby_field) : '_REG_date';
+		switch ($orderby_field) {
+			case '_REG_ID':
+				$orderby = ['REG_ID'];
+				break;
+			case '_Reg_status':
+				$orderby = ['STS_ID'];
+				break;
+			case 'ATT_fname':
+				$orderby = ['Attendee.ATT_fname', 'Attendee.ATT_lname'];
+				break;
+			case 'ATT_lname':
+				$orderby = ['Attendee.ATT_lname', 'Attendee.ATT_fname'];
+				break;
+			case 'event_name':
+				$orderby = ['Event.EVT_name'];
+				break;
+			case 'DTT_EVT_start':
+				$orderby = ['Event.Datetime.DTT_EVT_start'];
+				break;
+			case '_REG_date':
+				$orderby = ['REG_date'];
+				break;
+			default:
+				$orderby = [$orderby_field];
+				break;
+		}
+		$order = $this->request->getRequestParam('order');
+		$order = $order ? sanitize_text_field($order) : 'DESC';
+
+		$orderby = array_combine(
+			$orderby,
+			array_fill(0, count($orderby), $order)
+		);
+		// because there are many registrations with the same date, define
+		// a secondary way to order them, otherwise MySQL seems to be a bit random
+		if (empty($orderby['REG_ID'])) {
+			$orderby['REG_ID'] = $order;
+		}
+
+		$orderby = apply_filters(
+			'FHEE__Registrations_Admin_Page___get_orderby_for_registrations_query',
+			$orderby,
+			$this->request->requestParams()
+		);
+		return ['order_by' => $orderby];
+	}
+
+
+	/**
+	 * Sets up the limit for the registrations query.
+	 *
+	 * @param $per_page
+	 * @return array
+	 */
+	protected function getLimitClause($per_page)
+	{
+		$current_page = $this->request->getRequestParam('paged', 1, 'int');
+		$per_page = $this->request->getRequestParam('perpage', $per_page, 'int');
+		// -1 means return all results so get out if that's set.
+		if ($per_page === -1) {
+			return [];
+		}
+		$offset = ($current_page - 1) * $per_page;
+		return ['limit' => [$offset, $per_page]];
+	}
 }

core/domain/services/admin/registrations/list_table/page_header/EventFilterHeader.php

Indentation +54 added lines, -54 removed lines

@@ -24,62 +24,62 @@
 class EventFilterHeader extends AdminPageHeaderDecorator
 {
 
-    /**
-     * @var EEM_Event $event_model
-     */
-    private $event_model;
+	/**
+	 * @var EEM_Event $event_model
+	 */
+	private $event_model;
 
 
-    /**
-     * EventFilterHeader constructor.
-     *
-     * @param RequestInterface $request
-     * @param EEM_Event        $event_model
-     */
-    public function __construct(RequestInterface $request, EEM_Event $event_model)
-    {
-        parent::__construct($request);
-        $this->event_model = $event_model;
-    }
+	/**
+	 * EventFilterHeader constructor.
+	 *
+	 * @param RequestInterface $request
+	 * @param EEM_Event        $event_model
+	 */
+	public function __construct(RequestInterface $request, EEM_Event $event_model)
+	{
+		parent::__construct($request);
+		$this->event_model = $event_model;
+	}
 
 
-    /**
-     * @param string $text
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.10.2.p
-     */
-    public function getHeaderText($text = '')
-    {
-        $EVT_ID = $this->request->getRequestParam('EVT_ID');
-        $EVT_ID = $this->request->getRequestParam('event_id', $EVT_ID, 'int');
-        if ($EVT_ID) {
-            $event = $this->event_model->get_one_by_ID($EVT_ID);
-            if ($event instanceof EE_Event) {
-                $text .= sprintf(
-                    /* translators: %s: <h3>  %s: <a href>Event Name</a>  %s: </h3> */
-                    // phpcs:ignore WordPress.WP.I18n.UnorderedPlaceholdersText
-                    esc_html__('%s Viewing registrations for the event: %s%s', 'event_espresso'),
-                    '<h3 style="line-height:1.5em;">',
-                    '&nbsp;<a href="'
-                    . EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'action' => 'edit',
-                            'post'   => $event->ID(),
-                        ),
-                        EVENTS_ADMIN_URL
-                    )
-                    . '">'
-                    . $event->get('EVT_name')
-                    . '</a>&nbsp;',
-                    '</h3>'
-                );
-            }
-        }
-        return $text;
-    }
+	/**
+	 * @param string $text
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.10.2.p
+	 */
+	public function getHeaderText($text = '')
+	{
+		$EVT_ID = $this->request->getRequestParam('EVT_ID');
+		$EVT_ID = $this->request->getRequestParam('event_id', $EVT_ID, 'int');
+		if ($EVT_ID) {
+			$event = $this->event_model->get_one_by_ID($EVT_ID);
+			if ($event instanceof EE_Event) {
+				$text .= sprintf(
+					/* translators: %s: <h3>  %s: <a href>Event Name</a>  %s: </h3> */
+					// phpcs:ignore WordPress.WP.I18n.UnorderedPlaceholdersText
+					esc_html__('%s Viewing registrations for the event: %s%s', 'event_espresso'),
+					'<h3 style="line-height:1.5em;">',
+					'&nbsp;<a href="'
+					. EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'action' => 'edit',
+							'post'   => $event->ID(),
+						),
+						EVENTS_ADMIN_URL
+					)
+					. '">'
+					. $event->get('EVT_name')
+					. '</a>&nbsp;',
+					'</h3>'
+				);
+			}
+		}
+		return $text;
+	}
 }

core/domain/services/admin/registrations/list_table/page_header/TicketFilterHeader.php

Indentation +56 added lines, -56 removed lines

@@ -23,64 +23,64 @@
 class TicketFilterHeader extends AdminPageHeaderDecorator
 {
 
-    /**
-     * @var EEM_Ticket $ticket_model
-     */
-    private $ticket_model;
+	/**
+	 * @var EEM_Ticket $ticket_model
+	 */
+	private $ticket_model;
 
 
-    /**
-     * TicketFilterHeader constructor.
-     *
-     * @param RequestInterface $request
-     * @param EEM_Ticket       $ticket_model
-     */
-    public function __construct(RequestInterface $request, EEM_Ticket $ticket_model)
-    {
-        parent::__construct($request);
-        $this->ticket_model = $ticket_model;
-    }
+	/**
+	 * TicketFilterHeader constructor.
+	 *
+	 * @param RequestInterface $request
+	 * @param EEM_Ticket       $ticket_model
+	 */
+	public function __construct(RequestInterface $request, EEM_Ticket $ticket_model)
+	{
+		parent::__construct($request);
+		$this->ticket_model = $ticket_model;
+	}
 
 
-    /**
-     * @param string $text
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.10.2.p
-     */
-    public function getHeaderText($text = '')
-    {
-        $TKT_ID = $this->request->getRequestParam('TKT_ID');
-        $TKT_ID = $this->request->getRequestParam('ticket_id', $TKT_ID, 'int');
-        if ($TKT_ID) {
-            $ticket = $this->ticket_model->get_one_by_ID($TKT_ID);
-            if ($ticket instanceof EE_Ticket) {
-                $ticket_details = '<span class="ee-ticket-name">' . $ticket->name() . '</span> ';
-                $ticket_details .= ! $ticket->is_free()
-                    ? '<span class="ee-ticket-price">' . $ticket->pretty_price() . '</span>'
-                    : '<span class="reg-overview-free-event-spn">'
-                      . __('free', 'event_espresso')
-                      . '</span>';
-                // remove the closing h3 heading tag if it exists
-                $text = str_replace(
-                    '</h3>',
-                    '',
-                    $text
-                );
-                if (empty($text)) {
-                    $text = '<h3 style="line-height:1.5em;">';
-                    $text .= esc_html__('Viewing registrations for ticket:', 'event_espresso');
-                }
-                $text .= '&nbsp; &nbsp; ';
-                $text .= '<span class="drk-grey-text" style="font-size:.9em;">';
-                $text .= '<span class="dashicons dashicons-tickets-alt"></span>';
-                $text .= $ticket_details . '</span></h3>';
-            }
-        }
-        return $text;
-    }
+	/**
+	 * @param string $text
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.10.2.p
+	 */
+	public function getHeaderText($text = '')
+	{
+		$TKT_ID = $this->request->getRequestParam('TKT_ID');
+		$TKT_ID = $this->request->getRequestParam('ticket_id', $TKT_ID, 'int');
+		if ($TKT_ID) {
+			$ticket = $this->ticket_model->get_one_by_ID($TKT_ID);
+			if ($ticket instanceof EE_Ticket) {
+				$ticket_details = '<span class="ee-ticket-name">' . $ticket->name() . '</span> ';
+				$ticket_details .= ! $ticket->is_free()
+					? '<span class="ee-ticket-price">' . $ticket->pretty_price() . '</span>'
+					: '<span class="reg-overview-free-event-spn">'
+					  . __('free', 'event_espresso')
+					  . '</span>';
+				// remove the closing h3 heading tag if it exists
+				$text = str_replace(
+					'</h3>',
+					'',
+					$text
+				);
+				if (empty($text)) {
+					$text = '<h3 style="line-height:1.5em;">';
+					$text .= esc_html__('Viewing registrations for ticket:', 'event_espresso');
+				}
+				$text .= '&nbsp; &nbsp; ';
+				$text .= '<span class="drk-grey-text" style="font-size:.9em;">';
+				$text .= '<span class="dashicons dashicons-tickets-alt"></span>';
+				$text .= $ticket_details . '</span></h3>';
+			}
+		}
+		return $text;
+	}
 }

core/domain/services/admin/registrations/list_table/page_header/AttendeeFilterHeader.php

Indentation +47 added lines, -47 removed lines

@@ -20,55 +20,55 @@
 class AttendeeFilterHeader extends AdminPageHeaderDecorator
 {
 
-    /**
-     * @var EEM_Attendee $attendee_model
-     */
-    private $attendee_model;
+	/**
+	 * @var EEM_Attendee $attendee_model
+	 */
+	private $attendee_model;
 
 
-    /**
-     * AttendeeFilterHeader constructor.
-     *
-     * @param RequestInterface $request
-     * @param EEM_Attendee     $attendee_model
-     */
-    public function __construct(RequestInterface $request, EEM_Attendee $attendee_model)
-    {
-        parent::__construct($request);
-        $this->attendee_model = $attendee_model;
-    }
+	/**
+	 * AttendeeFilterHeader constructor.
+	 *
+	 * @param RequestInterface $request
+	 * @param EEM_Attendee     $attendee_model
+	 */
+	public function __construct(RequestInterface $request, EEM_Attendee $attendee_model)
+	{
+		parent::__construct($request);
+		$this->attendee_model = $attendee_model;
+	}
 
 
-    /**
-     * @param string $text
-     * @return string
-     * @throws EE_Error
-     * @since 4.10.2.p
-     */
-    public function getHeaderText($text = '')
-    {
-        $ATT_ID = $this->request->getRequestParam('ATT_ID');
-        $ATT_ID = $this->request->getRequestParam('attendee_id', $ATT_ID, 'int');
-        if ($ATT_ID) {
-            $attendee = $this->attendee_model->get_one_by_ID($ATT_ID);
-            if ($attendee instanceof EE_Attendee) {
-                $text .= sprintf(
-                    esc_html__(
-                        '%1$s Viewing registrations for %2$s%3$s',
-                        'event_espresso'
-                    ),
-                    '<h3 style="line-height:1.5em;">',
-                    '<a href="' . EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'action' => 'edit_attendee',
-                            'post'   => $ATT_ID,
-                        ),
-                        REG_ADMIN_URL
-                    ) . '">' . $attendee->full_name() . '</a>',
-                    '</h3>'
-                );
-            }
-        }
-        return $text;
-    }
+	/**
+	 * @param string $text
+	 * @return string
+	 * @throws EE_Error
+	 * @since 4.10.2.p
+	 */
+	public function getHeaderText($text = '')
+	{
+		$ATT_ID = $this->request->getRequestParam('ATT_ID');
+		$ATT_ID = $this->request->getRequestParam('attendee_id', $ATT_ID, 'int');
+		if ($ATT_ID) {
+			$attendee = $this->attendee_model->get_one_by_ID($ATT_ID);
+			if ($attendee instanceof EE_Attendee) {
+				$text .= sprintf(
+					esc_html__(
+						'%1$s Viewing registrations for %2$s%3$s',
+						'event_espresso'
+					),
+					'<h3 style="line-height:1.5em;">',
+					'<a href="' . EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'action' => 'edit_attendee',
+							'post'   => $ATT_ID,
+						),
+						REG_ADMIN_URL
+					) . '">' . $attendee->full_name() . '</a>',
+					'</h3>'
+				);
+			}
+		}
+		return $text;
+	}
 }

core/domain/services/admin/registrations/list_table/page_header/DateFilterHeader.php

Indentation +48 added lines, -48 removed lines

@@ -23,57 +23,57 @@
 class DateFilterHeader extends AdminPageHeaderDecorator
 {
 
-    /**
-     * @var EEM_Datetime $datetime_model
-     */
-    private $datetime_model;
+	/**
+	 * @var EEM_Datetime $datetime_model
+	 */
+	private $datetime_model;
 
 
-    /**
-     * DateFilterHeader constructor.
-     *
-     * @param RequestInterface $request
-     * @param EEM_Datetime     $datetime_model
-     */
-    public function __construct(RequestInterface $request, EEM_Datetime $datetime_model)
-    {
-        parent::__construct($request);
-        $this->datetime_model = $datetime_model;
-    }
+	/**
+	 * DateFilterHeader constructor.
+	 *
+	 * @param RequestInterface $request
+	 * @param EEM_Datetime     $datetime_model
+	 */
+	public function __construct(RequestInterface $request, EEM_Datetime $datetime_model)
+	{
+		parent::__construct($request);
+		$this->datetime_model = $datetime_model;
+	}
 
 
-    /**
-     * @param string $text
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.10.2.p
-     */
-    public function getHeaderText($text = '')
-    {
-        $DTT_ID = $this->request->getRequestParam('DTT_ID');
-        $DTT_ID = $this->request->getRequestParam('datetime_id', $DTT_ID, 'int');
-        if ($DTT_ID) {
-            $datetime = $this->datetime_model->get_one_by_ID($DTT_ID);
-            if ($datetime instanceof EE_Datetime && $text !== '') {
-                // remove the closing h3 heading tag if it exists
-                $text = str_replace(
-                    '</h3>',
-                    '',
-                    $text
-                );
-                $text .= '&nbsp; &nbsp; ';
-                $text .= '<span class="drk-grey-text">';
-                $text .= '<span class="dashicons dashicons-calendar"></span>';
-                $text .= $datetime->name();
-                $text .= ' ( ' . $datetime->start_date() . ' )';
-                $text .= '</span></h3>';
-            }
-        }
+	/**
+	 * @param string $text
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.10.2.p
+	 */
+	public function getHeaderText($text = '')
+	{
+		$DTT_ID = $this->request->getRequestParam('DTT_ID');
+		$DTT_ID = $this->request->getRequestParam('datetime_id', $DTT_ID, 'int');
+		if ($DTT_ID) {
+			$datetime = $this->datetime_model->get_one_by_ID($DTT_ID);
+			if ($datetime instanceof EE_Datetime && $text !== '') {
+				// remove the closing h3 heading tag if it exists
+				$text = str_replace(
+					'</h3>',
+					'',
+					$text
+				);
+				$text .= '&nbsp; &nbsp; ';
+				$text .= '<span class="drk-grey-text">';
+				$text .= '<span class="dashicons dashicons-calendar"></span>';
+				$text .= $datetime->name();
+				$text .= ' ( ' . $datetime->start_date() . ' )';
+				$text .= '</span></h3>';
+			}
+		}
 
-        return $text;
-    }
+		return $text;
+	}
 }

core/domain/services/pue/Stats.php

Indentation +204 added lines, -204 removed lines

@@ -22,86 +22,86 @@ 
 class Stats
 {
 
-    const OPTIONS_KEY_EXPIRY_TIMESTAMP_FOR_SENDING_STATS = 'ee_uxip_stats_expiry';
-
-    /**
-     * @var Config
-     */
-    private $config;
-
-
-    /**
-     * @var StatsGatherer
-     */
-    private $stats_gatherer;
-
-
-    /**
-     * @var EE_Maintenance_Mode
-     */
-    private $maintenance_mode;
-
-    public function __construct(
-        Config $config,
-        EE_Maintenance_Mode $maintenance_mode,
-        StatsGatherer $stats_gatherer
-    ) {
-        $this->config = $config;
-        $this->maintenance_mode = $maintenance_mode;
-        $this->stats_gatherer = $stats_gatherer;
-        $this->setUxipNotices();
-    }
-
-
-    /**
-     * Displays uxip opt-in notice if necessary.
-     */
-    private function setUxipNotices()
-    {
-        if ($this->canDisplayNotices()) {
-            add_action('admin_notices', array($this, 'optinNotice'));
-            add_action('admin_enqueue_scripts', array($this, 'enqueueScripts'));
-            add_action('wp_ajax_espresso_data_optin', array($this, 'ajaxHandler'));
-        }
-    }
-
-
-    /**
-     * This returns the callback that PluginUpdateEngineChecker will use for getting any extra stats to send.
-     *
-     * @return Closure
-     */
-    public function statsCallback()
-    {
-        // returns a callback that can is used to retrieve the stats to send along to the pue server.
-        return function () {
-            // we only send stats one a week, so let's see if our stat timestamp has expired.
-            if (! $this->sendStats()) {
-                return array();
-            }
-            return $this->stats_gatherer->stats();
-        };
-    }
-
-
-    /**
-     * Return whether notices can be displayed or not
-     *
-     * @return bool
-     */
-    private function canDisplayNotices()
-    {
-        return ! $this->config->hasNotifiedForUxip()
-               && $this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance;
-    }
-
-
-    /**
-     * Callback for the admin_notices hook that outputs the UXIP optin-in notice.
-     */
-    public function optinNotice()
-    {
-        ?>
+	const OPTIONS_KEY_EXPIRY_TIMESTAMP_FOR_SENDING_STATS = 'ee_uxip_stats_expiry';
+
+	/**
+	 * @var Config
+	 */
+	private $config;
+
+
+	/**
+	 * @var StatsGatherer
+	 */
+	private $stats_gatherer;
+
+
+	/**
+	 * @var EE_Maintenance_Mode
+	 */
+	private $maintenance_mode;
+
+	public function __construct(
+		Config $config,
+		EE_Maintenance_Mode $maintenance_mode,
+		StatsGatherer $stats_gatherer
+	) {
+		$this->config = $config;
+		$this->maintenance_mode = $maintenance_mode;
+		$this->stats_gatherer = $stats_gatherer;
+		$this->setUxipNotices();
+	}
+
+
+	/**
+	 * Displays uxip opt-in notice if necessary.
+	 */
+	private function setUxipNotices()
+	{
+		if ($this->canDisplayNotices()) {
+			add_action('admin_notices', array($this, 'optinNotice'));
+			add_action('admin_enqueue_scripts', array($this, 'enqueueScripts'));
+			add_action('wp_ajax_espresso_data_optin', array($this, 'ajaxHandler'));
+		}
+	}
+
+
+	/**
+	 * This returns the callback that PluginUpdateEngineChecker will use for getting any extra stats to send.
+	 *
+	 * @return Closure
+	 */
+	public function statsCallback()
+	{
+		// returns a callback that can is used to retrieve the stats to send along to the pue server.
+		return function () {
+			// we only send stats one a week, so let's see if our stat timestamp has expired.
+			if (! $this->sendStats()) {
+				return array();
+			}
+			return $this->stats_gatherer->stats();
+		};
+	}
+
+
+	/**
+	 * Return whether notices can be displayed or not
+	 *
+	 * @return bool
+	 */
+	private function canDisplayNotices()
+	{
+		return ! $this->config->hasNotifiedForUxip()
+			   && $this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance;
+	}
+
+
+	/**
+	 * Callback for the admin_notices hook that outputs the UXIP optin-in notice.
+	 */
+	public function optinNotice()
+	{
+		?>
         <div class="updated data-collect-optin" id="espresso-data-collect-optin-container">
             <div id="data-collect-optin-options-container">
                 <span class="dashicons dashicons-admin-site"></span>
@@ -114,128 +114,128 @@ 
             </div>
         </div>
         <?php
-    }
-
-
-    /**
-     * Retrieves the optin text (static so it can be used in multiple places as necessary).
-     *
-     * @param bool $extra
-     */
-    public static function optinText($extra = true)
-    {
-        if (! $extra) {
-            echo '<h2 class="ee-admin-settings-hdr" '
-                 . (! $extra ? 'id="UXIP_settings"' : '')
-                 . '>'
-                 . esc_html__('User eXperience Improvement Program (UXIP)', 'event_espresso')
-                 . EEH_Template::get_help_tab_link('organization_logo_info')
-                 . '</h2>';
-            printf(
-                esc_html__(
-                    '%1$sPlease help us make Event Espresso better and vote for your favorite features.%2$s The %3$sUser eXperience Improvement Program (UXIP)%4$s, has been created so when you use Event Espresso you are voting for the features and settings that are important to you. The UXIP helps us understand how you use our products and services, track problems and in what context. If you opt-out of the UXIP you essentially elect for us to disregard how you use Event Espresso as we build new features and make changes. Participation in the program is completely voluntary and it is disabled by default. The end results of the UXIP are software improvements to better meet your needs. The data we collect will never be sold, traded, or misused in any way. %5$sPlease see our %6$sPrivacy Policy%7$s for more information.',
-                    'event_espresso'
-                ),
-                '<p><em>',
-                '</em></p>',
-                '<a href="https://eventespresso.com/about/user-experience-improvement-program-uxip/" target="_blank">',
-                '</a>',
-                '<br><br>',
-                '<a href="https://eventespresso.com/about/privacy-policy/" target="_blank">',
-                '</a>'
-            );
-        } else {
-            $settings_url = EEH_URL::add_query_args_and_nonce(
-                array('action' => 'default'),
-                admin_url('admin.php?page=espresso_general_settings')
-            );
-            $settings_url .= '#UXIP_settings';
-            printf(
-                esc_html__(
-                    'The Event Espresso UXIP feature is not yet active on your site. For %1$smore info%2$s and to opt-in %3$sclick here%4$s.',
-                    'event_espresso'
-                ),
-                '<a href="https://eventespresso.com/about/user-experience-improvement-program-uxip/" target="_blank">',
-                '</a>',
-                '<a href="' . $settings_url . '" target="_blank">',
-                '</a>'
-            );
-        }
-    }
-
-
-    /**
-     * Callback for admin_enqueue_scripts that sets up the scripts and styles for the uxip notice
-     */
-    public function enqueueScripts()
-    {
-        wp_register_script(
-            'ee-data-optin-js',
-            EE_GLOBAL_ASSETS_URL . 'scripts/ee-data-optin.js',
-            array('jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_style(
-            'ee-data-optin-css',
-            EE_GLOBAL_ASSETS_URL . 'css/ee-data-optin.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-
-        wp_enqueue_script('ee-data-optin-js');
-        wp_enqueue_style('ee-data-optin-css');
-    }
-
-
-    /**
-     * Callback for wp_ajax_espresso_data_optin that handles the ajax request
-     */
-    public function ajaxHandler()
-    {
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $nonce = $request->getRequestParam('nonce');
-        // verify nonce
-        if (! $nonce || ! wp_verify_nonce($nonce, 'ee-data-optin')) {
-            exit();
-        }
-
-        // update has notified option
-        $this->config->setHasNotifiedAboutUxip();
-        exit();
-    }
-
-
-    /**
-     * Used to determine whether additional stats are sent.
-     */
-    private function sendStats()
-    {
-        return $this->config->isOptedInForUxip()
-               && $this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
-               && $this->statSendTimestampExpired();
-    }
-
-
-    /**
-     * Returns true when the timestamp used to track whether stats get sent (currently a weekly interval) is expired.
-     * Returns false otherwise.
-     *
-     * @return bool
-     */
-    private function statSendTimestampExpired()
-    {
-        $current_expiry = get_option(self::OPTIONS_KEY_EXPIRY_TIMESTAMP_FOR_SENDING_STATS, null);
-        if ($current_expiry === null) {
-            add_option(self::OPTIONS_KEY_EXPIRY_TIMESTAMP_FOR_SENDING_STATS, time() + WEEK_IN_SECONDS, '', 'no');
-            return true;
-        }
-
-        if (time() > (int) $current_expiry) {
-            update_option(self::OPTIONS_KEY_EXPIRY_TIMESTAMP_FOR_SENDING_STATS, time() + WEEK_IN_SECONDS);
-            return true;
-        }
-        return false;
-    }
+	}
+
+
+	/**
+	 * Retrieves the optin text (static so it can be used in multiple places as necessary).
+	 *
+	 * @param bool $extra
+	 */
+	public static function optinText($extra = true)
+	{
+		if (! $extra) {
+			echo '<h2 class="ee-admin-settings-hdr" '
+				 . (! $extra ? 'id="UXIP_settings"' : '')
+				 . '>'
+				 . esc_html__('User eXperience Improvement Program (UXIP)', 'event_espresso')
+				 . EEH_Template::get_help_tab_link('organization_logo_info')
+				 . '</h2>';
+			printf(
+				esc_html__(
+					'%1$sPlease help us make Event Espresso better and vote for your favorite features.%2$s The %3$sUser eXperience Improvement Program (UXIP)%4$s, has been created so when you use Event Espresso you are voting for the features and settings that are important to you. The UXIP helps us understand how you use our products and services, track problems and in what context. If you opt-out of the UXIP you essentially elect for us to disregard how you use Event Espresso as we build new features and make changes. Participation in the program is completely voluntary and it is disabled by default. The end results of the UXIP are software improvements to better meet your needs. The data we collect will never be sold, traded, or misused in any way. %5$sPlease see our %6$sPrivacy Policy%7$s for more information.',
+					'event_espresso'
+				),
+				'<p><em>',
+				'</em></p>',
+				'<a href="https://eventespresso.com/about/user-experience-improvement-program-uxip/" target="_blank">',
+				'</a>',
+				'<br><br>',
+				'<a href="https://eventespresso.com/about/privacy-policy/" target="_blank">',
+				'</a>'
+			);
+		} else {
+			$settings_url = EEH_URL::add_query_args_and_nonce(
+				array('action' => 'default'),
+				admin_url('admin.php?page=espresso_general_settings')
+			);
+			$settings_url .= '#UXIP_settings';
+			printf(
+				esc_html__(
+					'The Event Espresso UXIP feature is not yet active on your site. For %1$smore info%2$s and to opt-in %3$sclick here%4$s.',
+					'event_espresso'
+				),
+				'<a href="https://eventespresso.com/about/user-experience-improvement-program-uxip/" target="_blank">',
+				'</a>',
+				'<a href="' . $settings_url . '" target="_blank">',
+				'</a>'
+			);
+		}
+	}
+
+
+	/**
+	 * Callback for admin_enqueue_scripts that sets up the scripts and styles for the uxip notice
+	 */
+	public function enqueueScripts()
+	{
+		wp_register_script(
+			'ee-data-optin-js',
+			EE_GLOBAL_ASSETS_URL . 'scripts/ee-data-optin.js',
+			array('jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_style(
+			'ee-data-optin-css',
+			EE_GLOBAL_ASSETS_URL . 'css/ee-data-optin.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+
+		wp_enqueue_script('ee-data-optin-js');
+		wp_enqueue_style('ee-data-optin-css');
+	}
+
+
+	/**
+	 * Callback for wp_ajax_espresso_data_optin that handles the ajax request
+	 */
+	public function ajaxHandler()
+	{
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$nonce = $request->getRequestParam('nonce');
+		// verify nonce
+		if (! $nonce || ! wp_verify_nonce($nonce, 'ee-data-optin')) {
+			exit();
+		}
+
+		// update has notified option
+		$this->config->setHasNotifiedAboutUxip();
+		exit();
+	}
+
+
+	/**
+	 * Used to determine whether additional stats are sent.
+	 */
+	private function sendStats()
+	{
+		return $this->config->isOptedInForUxip()
+			   && $this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
+			   && $this->statSendTimestampExpired();
+	}
+
+
+	/**
+	 * Returns true when the timestamp used to track whether stats get sent (currently a weekly interval) is expired.
+	 * Returns false otherwise.
+	 *
+	 * @return bool
+	 */
+	private function statSendTimestampExpired()
+	{
+		$current_expiry = get_option(self::OPTIONS_KEY_EXPIRY_TIMESTAMP_FOR_SENDING_STATS, null);
+		if ($current_expiry === null) {
+			add_option(self::OPTIONS_KEY_EXPIRY_TIMESTAMP_FOR_SENDING_STATS, time() + WEEK_IN_SECONDS, '', 'no');
+			return true;
+		}
+
+		if (time() > (int) $current_expiry) {
+			update_option(self::OPTIONS_KEY_EXPIRY_TIMESTAMP_FOR_SENDING_STATS, time() + WEEK_IN_SECONDS);
+			return true;
+		}
+		return false;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -74,9 +74,9 @@ 
     public function statsCallback()
     {
         // returns a callback that can is used to retrieve the stats to send along to the pue server.
-        return function () {
+        return function() {
             // we only send stats one a week, so let's see if our stat timestamp has expired.
-            if (! $this->sendStats()) {
+            if ( ! $this->sendStats()) {
                 return array();
             }
             return $this->stats_gatherer->stats();
@@ -124,9 +124,9 @@ 
      */
     public static function optinText($extra = true)
     {
-        if (! $extra) {
+        if ( ! $extra) {
             echo '<h2 class="ee-admin-settings-hdr" '
-                 . (! $extra ? 'id="UXIP_settings"' : '')
+                 . ( ! $extra ? 'id="UXIP_settings"' : '')
                  . '>'
                  . esc_html__('User eXperience Improvement Program (UXIP)', 'event_espresso')
                  . EEH_Template::get_help_tab_link('organization_logo_info')
@@ -157,7 +157,7 @@ 
                 ),
                 '<a href="https://eventespresso.com/about/user-experience-improvement-program-uxip/" target="_blank">',
                 '</a>',
-                '<a href="' . $settings_url . '" target="_blank">',
+                '<a href="'.$settings_url.'" target="_blank">',
                 '</a>'
             );
         }
@@ -171,14 +171,14 @@ 
     {
         wp_register_script(
             'ee-data-optin-js',
-            EE_GLOBAL_ASSETS_URL . 'scripts/ee-data-optin.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/ee-data-optin.js',
             array('jquery'),
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_style(
             'ee-data-optin-css',
-            EE_GLOBAL_ASSETS_URL . 'css/ee-data-optin.css',
+            EE_GLOBAL_ASSETS_URL.'css/ee-data-optin.css',
             array(),
             EVENT_ESPRESSO_VERSION
         );
@@ -197,7 +197,7 @@ 
         $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
         $nonce = $request->getRequestParam('nonce');
         // verify nonce
-        if (! $nonce || ! wp_verify_nonce($nonce, 'ee-data-optin')) {
+        if ( ! $nonce || ! wp_verify_nonce($nonce, 'ee-data-optin')) {
             exit();
         }
 

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

Indentation +157 added lines, -157 removed lines

@@ -21,172 +21,172 @@
 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(self::BLOCK_TYPE);
-        $this->setSupportedRoutes(
-            array(
-                'EventEspresso\core\domain\entities\route_match\specifications\admin\EspressoStandardPostTypeEditor',
-                'EventEspresso\core\domain\entities\route_match\specifications\admin\WordPressPostTypeEditor',
-                'EventEspresso\core\domain\entities\route_match\specifications\frontend\EspressoBlockRenderer',
-                'EventEspresso\core\domain\entities\route_match\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' => EEM_Registration::status_id_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(self::BLOCK_TYPE);
+		$this->setSupportedRoutes(
+			array(
+				'EventEspresso\core\domain\entities\route_match\specifications\admin\EspressoStandardPostTypeEditor',
+				'EventEspresso\core\domain\entities\route_match\specifications\admin\WordPressPostTypeEditor',
+				'EventEspresso\core\domain\entities\route_match\specifications\frontend\EspressoBlockRenderer',
+				'EventEspresso\core\domain\entities\route_match\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' => EEM_Registration::status_id_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(
-            '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(
+			'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);
-        return (is_archive() || is_front_page() || is_home()) && ! $attributes['displayOnArchives']
-            ? ''
-            : $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);
+		return (is_archive() || is_front_page() || is_home()) && ! $attributes['displayOnArchives']
+			? ''
+			: $this->renderer->render($attributes);
+	}
 }