eventespresso / event-espresso-core

core/services/request/Response.php

Spacing +3 added lines, -3 removed lines

@@ -58,7 +58,7 @@ 
      */
     public function setNotice($key, $value)
     {
-        $this->notice[ $key ] = $value;
+        $this->notice[$key] = $value;
     }
 
 
@@ -69,7 +69,7 @@ 
      */
     public function getNotice($key)
     {
-        return isset($this->notice[ $key ]) ? $this->notice[ $key ] : null;
+        return isset($this->notice[$key]) ? $this->notice[$key] : null;
     }
 
 
@@ -90,7 +90,7 @@ 
      */
     public function addOutput($string, $append = true)
     {
-        $this->output = $append ? $this->output . $string : $string . $this->output;
+        $this->output = $append ? $this->output.$string : $string.$this->output;
     }
 
 

Indentation +115 added lines, -115 removed lines

@@ -16,119 +16,119 @@
 class Response implements ResponseInterface, ReservedInstanceInterface
 {
 
-    /**
-     * @var array $notice
-     */
-    protected $notice = array();
-
-    /**
-     * rendered output to be returned to WP
-     *
-     * @var string $output
-     */
-    protected $output = '';
-
-    /**
-     * @var bool
-     */
-    protected $request_terminated = false;
-
-    /**
-     * @var bool $deactivate_plugin
-     */
-    protected $deactivate_plugin = false;
-
-
-    /**
-     * EE_Response constructor.
-     */
-    public function __construct()
-    {
-        $this->terminateRequest(false);
-    }
-
-
-    /**
-     * @param $key
-     * @param $value
-     * @return    void
-     */
-    public function setNotice($key, $value)
-    {
-        $this->notice[ $key ] = $value;
-    }
-
-
-    /**
-     * @param $key
-     * @return    mixed
-     */
-    public function getNotice($key)
-    {
-        return isset($this->notice[ $key ]) ? $this->notice[ $key ] : null;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getNotices()
-    {
-        return $this->notice;
-    }
-
-
-    /**
-     * @param string $string
-     * @param bool   $append
-     */
-    public function addOutput($string, $append = true)
-    {
-        $this->output = $append ? $this->output . $string : $string . $this->output;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getOutput()
-    {
-        return $this->output;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function requestTerminated()
-    {
-        return $this->request_terminated;
-    }
-
-
-    /**
-     * @param boolean $request_terminated
-     */
-    public function terminateRequest($request_terminated = true)
-    {
-        $this->request_terminated = filter_var($request_terminated, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function pluginDeactivated()
-    {
-        return $this->deactivate_plugin;
-    }
-
-
-    /**
-     * sets $deactivate_plugin to true
-     */
-    public function deactivatePlugin()
-    {
-        $this->deactivate_plugin = true;
-    }
+	/**
+	 * @var array $notice
+	 */
+	protected $notice = array();
+
+	/**
+	 * rendered output to be returned to WP
+	 *
+	 * @var string $output
+	 */
+	protected $output = '';
+
+	/**
+	 * @var bool
+	 */
+	protected $request_terminated = false;
+
+	/**
+	 * @var bool $deactivate_plugin
+	 */
+	protected $deactivate_plugin = false;
+
+
+	/**
+	 * EE_Response constructor.
+	 */
+	public function __construct()
+	{
+		$this->terminateRequest(false);
+	}
+
+
+	/**
+	 * @param $key
+	 * @param $value
+	 * @return    void
+	 */
+	public function setNotice($key, $value)
+	{
+		$this->notice[ $key ] = $value;
+	}
+
+
+	/**
+	 * @param $key
+	 * @return    mixed
+	 */
+	public function getNotice($key)
+	{
+		return isset($this->notice[ $key ]) ? $this->notice[ $key ] : null;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getNotices()
+	{
+		return $this->notice;
+	}
+
+
+	/**
+	 * @param string $string
+	 * @param bool   $append
+	 */
+	public function addOutput($string, $append = true)
+	{
+		$this->output = $append ? $this->output . $string : $string . $this->output;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getOutput()
+	{
+		return $this->output;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function requestTerminated()
+	{
+		return $this->request_terminated;
+	}
+
+
+	/**
+	 * @param boolean $request_terminated
+	 */
+	public function terminateRequest($request_terminated = true)
+	{
+		$this->request_terminated = filter_var($request_terminated, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function pluginDeactivated()
+	{
+		return $this->deactivate_plugin;
+	}
+
+
+	/**
+	 * sets $deactivate_plugin to true
+	 */
+	public function deactivatePlugin()
+	{
+		$this->deactivate_plugin = true;
+	}
 }

core/services/request/middleware/PreProductionVersionWarning.php

Spacing +1 added lines, -1 removed lines

@@ -78,7 +78,7 @@
     public function preProductionVersionAdminNotice()
     {
         new PersistentAdminNotice(
-            'preProductionVersionAdminNotice_' . EVENT_ESPRESSO_VERSION,
+            'preProductionVersionAdminNotice_'.EVENT_ESPRESSO_VERSION,
             $this->warningNotice()
         );
     }

Indentation +79 added lines, -79 removed lines

@@ -18,91 +18,91 @@
 class PreProductionVersionWarning extends Middleware
 {
 
-    /**
-     * converts a Request to a Response
-     *
-     * @param RequestInterface  $request
-     * @param ResponseInterface $response
-     * @return ResponseInterface
-     */
-    public function handleRequest(RequestInterface $request, ResponseInterface $response)
-    {
-        $this->request = $request;
-        $this->response = $response;
-        $this->displayPreProductionVersionWarning();
-        $this->response = $this->processRequestStack($this->request, $this->response);
-        return $this->response;
-    }
+	/**
+	 * converts a Request to a Response
+	 *
+	 * @param RequestInterface  $request
+	 * @param ResponseInterface $response
+	 * @return ResponseInterface
+	 */
+	public function handleRequest(RequestInterface $request, ResponseInterface $response)
+	{
+		$this->request = $request;
+		$this->response = $response;
+		$this->displayPreProductionVersionWarning();
+		$this->response = $this->processRequestStack($this->request, $this->response);
+		return $this->response;
+	}
 
 
-    /**
-     * displays message on frontend of site notifying admin that EE has been temporarily placed into maintenance mode
-     *
-     * @return void
-     */
-    public function displayPreProductionVersionWarning()
-    {
-        // skip AJAX requests
-        if ($this->request->isAjax()) {
-            return;
-        }
-        // skip stable releases
-        if (substr(EVENT_ESPRESSO_VERSION, -5) !== '.beta') {
-            return;
-        }
-        // site admin has authorized use of non-stable release candidate for production
-        if (defined('ALLOW_NON_STABLE_RELEASE_ON_LIVE_SITE') && ALLOW_NON_STABLE_RELEASE_ON_LIVE_SITE) {
-            return;
-        }
-        // post release candidate warning
-        if ($this->request->isAdmin()) {
-            add_action('admin_notices', array($this, 'preProductionVersionAdminNotice'), -999);
-        } else {
-            add_action('shutdown', array($this, 'preProductionVersionWarningNotice'), 10);
-        }
-    }
+	/**
+	 * displays message on frontend of site notifying admin that EE has been temporarily placed into maintenance mode
+	 *
+	 * @return void
+	 */
+	public function displayPreProductionVersionWarning()
+	{
+		// skip AJAX requests
+		if ($this->request->isAjax()) {
+			return;
+		}
+		// skip stable releases
+		if (substr(EVENT_ESPRESSO_VERSION, -5) !== '.beta') {
+			return;
+		}
+		// site admin has authorized use of non-stable release candidate for production
+		if (defined('ALLOW_NON_STABLE_RELEASE_ON_LIVE_SITE') && ALLOW_NON_STABLE_RELEASE_ON_LIVE_SITE) {
+			return;
+		}
+		// post release candidate warning
+		if ($this->request->isAdmin()) {
+			add_action('admin_notices', array($this, 'preProductionVersionAdminNotice'), -999);
+		} else {
+			add_action('shutdown', array($this, 'preProductionVersionWarningNotice'), 10);
+		}
+	}
 
 
-    /**
-     * displays admin notice that current version of EE is not a stable release
-     *
-     * @return void
-     * @throws InvalidDataTypeException
-     */
-    public function preProductionVersionAdminNotice()
-    {
-        new PersistentAdminNotice(
-            'preProductionVersionAdminNotice_' . EVENT_ESPRESSO_VERSION,
-            $this->warningNotice()
-        );
-    }
+	/**
+	 * displays admin notice that current version of EE is not a stable release
+	 *
+	 * @return void
+	 * @throws InvalidDataTypeException
+	 */
+	public function preProductionVersionAdminNotice()
+	{
+		new PersistentAdminNotice(
+			'preProductionVersionAdminNotice_' . EVENT_ESPRESSO_VERSION,
+			$this->warningNotice()
+		);
+	}
 
 
-    /**
-     * displays message on frontend of site notifying admin that current version of EE is not a stable release
-     *
-     * @return void
-     */
-    public function preProductionVersionWarningNotice()
-    {
-        echo '<div id="ee-release-candidate-notice-dv" class="ee-really-important-notice-dv"><p>';
-        echo $this->warningNotice();
-        echo '</p></div>';
-    }
+	/**
+	 * displays message on frontend of site notifying admin that current version of EE is not a stable release
+	 *
+	 * @return void
+	 */
+	public function preProductionVersionWarningNotice()
+	{
+		echo '<div id="ee-release-candidate-notice-dv" class="ee-really-important-notice-dv"><p>';
+		echo $this->warningNotice();
+		echo '</p></div>';
+	}
 
 
-    /**
-     * @return string
-     */
-    private function warningNotice()
-    {
-        return sprintf(
-            esc_html__(
-                'This version of Event Espresso is for testing and/or evaluation purposes only. It is %1$snot%2$s considered a stable release and should therefore %1$snot%2$s be activated on a live or production website.',
-                'event_espresso'
-            ),
-            '<strong>',
-            '</strong>'
-        );
-    }
+	/**
+	 * @return string
+	 */
+	private function warningNotice()
+	{
+		return sprintf(
+			esc_html__(
+				'This version of Event Espresso is for testing and/or evaluation purposes only. It is %1$snot%2$s considered a stable release and should therefore %1$snot%2$s be activated on a live or production website.',
+				'event_espresso'
+			),
+			'<strong>',
+			'</strong>'
+		);
+	}
 }

core/services/request/RequestStack.php

Indentation +45 added lines, -45 removed lines

@@ -19,59 +19,59 @@
 class RequestStack
 {
 
-    /**
-     * @var RequestDecoratorInterface $request_stack_app
-     */
-    protected $request_stack_app;
+	/**
+	 * @var RequestDecoratorInterface $request_stack_app
+	 */
+	protected $request_stack_app;
 
-    /**
-     * @var RequestStackCoreAppInterface $core_app
-     */
-    protected $core_app;
+	/**
+	 * @var RequestStackCoreAppInterface $core_app
+	 */
+	protected $core_app;
 
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
 
-    /**
-     * @var ResponseInterface $response
-     */
-    protected $response;
+	/**
+	 * @var ResponseInterface $response
+	 */
+	protected $response;
 
 
-    /**
-     * @param RequestDecoratorInterface    $request_stack_app
-     * @param RequestStackCoreAppInterface $core_app
-     */
-    public function __construct(RequestDecoratorInterface $request_stack_app, RequestStackCoreAppInterface $core_app)
-    {
-        $this->request_stack_app = $request_stack_app;
-        $this->core_app      = $core_app;
-    }
+	/**
+	 * @param RequestDecoratorInterface    $request_stack_app
+	 * @param RequestStackCoreAppInterface $core_app
+	 */
+	public function __construct(RequestDecoratorInterface $request_stack_app, RequestStackCoreAppInterface $core_app)
+	{
+		$this->request_stack_app = $request_stack_app;
+		$this->core_app      = $core_app;
+	}
 
 
-    /**
-     * @param RequestInterface  $request
-     * @param ResponseInterface $response
-     * @return ResponseInterface
-     */
-    public function handleRequest(RequestInterface $request, ResponseInterface $response)
-    {
-        $this->request  = $request;
-        $this->response = $response;
-        return $this->request_stack_app->handleRequest($request, $response);
-    }
+	/**
+	 * @param RequestInterface  $request
+	 * @param ResponseInterface $response
+	 * @return ResponseInterface
+	 */
+	public function handleRequest(RequestInterface $request, ResponseInterface $response)
+	{
+		$this->request  = $request;
+		$this->response = $response;
+		return $this->request_stack_app->handleRequest($request, $response);
+	}
 
 
-    /**
-     * handle_response
-     * executes the handle_response() method on the RequestStackCoreAppInterface object
-     * after the request stack has been fully processed
-     */
-    public function handleResponse()
-    {
-        $this->core_app->handleResponse($this->request, $this->response);
-    }
+	/**
+	 * handle_response
+	 * executes the handle_response() method on the RequestStackCoreAppInterface object
+	 * after the request stack has been fully processed
+	 */
+	public function handleResponse()
+	{
+		$this->core_app->handleResponse($this->request, $this->response);
+	}
 }
 // Location: RequestStack.php

Spacing +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
     public function __construct(RequestDecoratorInterface $request_stack_app, RequestStackCoreAppInterface $core_app)
     {
         $this->request_stack_app = $request_stack_app;
-        $this->core_app      = $core_app;
+        $this->core_app = $core_app;
     }
 
 

core/services/collections/iterators/CollectionFilterCallbackIterator.php

Indentation +47 added lines, -47 removed lines

@@ -9,51 +9,51 @@
 class CollectionFilterCallbackIterator extends FilterIterator
 {
 
-    /**
-     * Used for determining whether the iterated object in the Collection is "valid" or not.
-     * @var Closure
-     */
-    private $acceptance_callback;
-
-
-    /**
-     * CollectionFilterCallbackIterator constructor.
-     *
-     * @param Collection $collection
-     * @param Closure    $acceptance_callback  The closure will receive an instance of whatever object is stored on the
-     *                                         collection when iterating over the collection and should return boolean.
-     */
-    public function __construct(Collection $collection, Closure $acceptance_callback)
-    {
-        $this->acceptance_callback = $acceptance_callback;
-        parent::__construct($collection);
-    }
-
-    /**
-     * Check whether the current element of the iterator is acceptable
-     *
-     * @link  http://php.net/manual/en/filteriterator.accept.php
-     * @return bool true if the current element is acceptable, otherwise false.
-     */
-    public function accept()
-    {
-        $acceptance_callback = $this->acceptance_callback;
-        return $acceptance_callback($this->getInnerIterator()->current());
-    }
-
-
-
-    /**
-     * Returns a filtered array of objects from the collection using the provided acceptance callback
-     * @return array
-     */
-    public function getFiltered()
-    {
-        $filtered_array = array();
-        $this->rewind();
-        foreach ($this as $filtered_object) {
-            $filtered_array[] = $filtered_object;
-        }
-        return $filtered_array;
-    }
+	/**
+	 * Used for determining whether the iterated object in the Collection is "valid" or not.
+	 * @var Closure
+	 */
+	private $acceptance_callback;
+
+
+	/**
+	 * CollectionFilterCallbackIterator constructor.
+	 *
+	 * @param Collection $collection
+	 * @param Closure    $acceptance_callback  The closure will receive an instance of whatever object is stored on the
+	 *                                         collection when iterating over the collection and should return boolean.
+	 */
+	public function __construct(Collection $collection, Closure $acceptance_callback)
+	{
+		$this->acceptance_callback = $acceptance_callback;
+		parent::__construct($collection);
+	}
+
+	/**
+	 * Check whether the current element of the iterator is acceptable
+	 *
+	 * @link  http://php.net/manual/en/filteriterator.accept.php
+	 * @return bool true if the current element is acceptable, otherwise false.
+	 */
+	public function accept()
+	{
+		$acceptance_callback = $this->acceptance_callback;
+		return $acceptance_callback($this->getInnerIterator()->current());
+	}
+
+
+
+	/**
+	 * Returns a filtered array of objects from the collection using the provided acceptance callback
+	 * @return array
+	 */
+	public function getFiltered()
+	{
+		$filtered_array = array();
+		$this->rewind();
+		foreach ($this as $filtered_object) {
+			$filtered_array[] = $filtered_object;
+		}
+		return $filtered_array;
+	}
 }

core/services/helpers/datetime/HelperInterface.php

Indentation +90 added lines, -90 removed lines

@@ -16,94 +16,94 @@
 interface HelperInterface
 {
 
-    /**
-     * Ensures that a valid timezone string is returned.
-     *
-     * @param string $timezone_string  When not provided then attempt to use the timezone_string set in the WP Time
-     *                                 settings (or derive from set UTC offset).
-     * @return string
-     */
-    public function getValidTimezoneString($timezone_string = '');
-
-
-    /**
-     * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
-     *
-     * @param string $timezone_string
-     * @param bool   $throw_error
-     * @return bool
-     */
-    public function validateTimezone($timezone_string, $throw_error = true);
-
-
-    /**
-     * Returns a timezone string for the provided gmt_offset.
-     * @param float|string $gmt_offset
-     * @return string
-     */
-    public function getTimezoneStringFromGmtOffset($gmt_offset = '');
-
-
-    /**
-     * Gets the site's GMT offset based on either the timezone string
-     * (in which case the gmt offset will vary depending on the location's
-     * observance of daylight savings time) or the gmt_offset wp option
-     *
-     * @return int  seconds offset
-     */
-    public function getSiteTimezoneGmtOffset();
-
-
-    /**
-     * Get timezone transitions
-     * @param DateTimeZone $date_time_zone
-     * @param int|null     $time
-     * @param bool         $first_only
-     * @return array
-     */
-    public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true);
-
-
-    /**
-     * Get Timezone offset for given timezone object
-     * @param DateTimeZone $date_time_zone
-     * @param null|int         $time
-     * @return int
-     */
-    public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null);
-
-
-    /**
-     * Provide a timezone select input
-     * @param string $timezone_string
-     * @return string
-     */
-    public function timezoneSelectInput($timezone_string = '');
-
-
-    /**
-     * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
-     * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
-     * the site is used.
-     * This is used typically when using a Unix timestamp any core WP functions that expect their specially
-     * computed timestamp (i.e. date_i18n() )
-     *
-     * @param int    $unix_timestamp    if 0, then time() will be used.
-     * @param string $timezone_string timezone_string. If empty, then the current set timezone for the
-     *                                site will be used.
-     * @return int      unix_timestamp value with the offset applied for the given timezone.
-     */
-    public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = '');
-
-
-    /**
-     * Depending on PHP version,
-     * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
-     * To get around that, for these fringe timezones we bump them to a known valid offset.
-     * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
-     *
-     * @param int $gmt_offset
-     * @return int
-     */
-    public function adjustInvalidGmtOffsets($gmt_offset);
+	/**
+	 * Ensures that a valid timezone string is returned.
+	 *
+	 * @param string $timezone_string  When not provided then attempt to use the timezone_string set in the WP Time
+	 *                                 settings (or derive from set UTC offset).
+	 * @return string
+	 */
+	public function getValidTimezoneString($timezone_string = '');
+
+
+	/**
+	 * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
+	 *
+	 * @param string $timezone_string
+	 * @param bool   $throw_error
+	 * @return bool
+	 */
+	public function validateTimezone($timezone_string, $throw_error = true);
+
+
+	/**
+	 * Returns a timezone string for the provided gmt_offset.
+	 * @param float|string $gmt_offset
+	 * @return string
+	 */
+	public function getTimezoneStringFromGmtOffset($gmt_offset = '');
+
+
+	/**
+	 * Gets the site's GMT offset based on either the timezone string
+	 * (in which case the gmt offset will vary depending on the location's
+	 * observance of daylight savings time) or the gmt_offset wp option
+	 *
+	 * @return int  seconds offset
+	 */
+	public function getSiteTimezoneGmtOffset();
+
+
+	/**
+	 * Get timezone transitions
+	 * @param DateTimeZone $date_time_zone
+	 * @param int|null     $time
+	 * @param bool         $first_only
+	 * @return array
+	 */
+	public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true);
+
+
+	/**
+	 * Get Timezone offset for given timezone object
+	 * @param DateTimeZone $date_time_zone
+	 * @param null|int         $time
+	 * @return int
+	 */
+	public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null);
+
+
+	/**
+	 * Provide a timezone select input
+	 * @param string $timezone_string
+	 * @return string
+	 */
+	public function timezoneSelectInput($timezone_string = '');
+
+
+	/**
+	 * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
+	 * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
+	 * the site is used.
+	 * This is used typically when using a Unix timestamp any core WP functions that expect their specially
+	 * computed timestamp (i.e. date_i18n() )
+	 *
+	 * @param int    $unix_timestamp    if 0, then time() will be used.
+	 * @param string $timezone_string timezone_string. If empty, then the current set timezone for the
+	 *                                site will be used.
+	 * @return int      unix_timestamp value with the offset applied for the given timezone.
+	 */
+	public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = '');
+
+
+	/**
+	 * Depending on PHP version,
+	 * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
+	 * To get around that, for these fringe timezones we bump them to a known valid offset.
+	 * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
+	 *
+	 * @param int $gmt_offset
+	 * @return int
+	 */
+	public function adjustInvalidGmtOffsets($gmt_offset);
 }

core/services/context/ContextChecker.php

Spacing +1 added lines, -1 removed lines

@@ -87,7 +87,7 @@
     {
         $this->evaluation_callback = $evaluation_callback instanceof Closure
             ? $evaluation_callback
-            : function (ContextInterface $context, $acceptable_values) {
+            : function(ContextInterface $context, $acceptable_values) {
                 return in_array($context->slug(), $acceptable_values, true);
             };
     }

Indentation +141 added lines, -141 removed lines

@@ -17,145 +17,145 @@
 class ContextChecker
 {
 
-    /**
-     * A unique string used to identify where this ContextChecker is being employed
-     * Is currently only used within the hook name for the filterable return value of isAllowed().
-     *
-     * @var string $identifier
-     */
-    private $identifier;
-
-    /**
-     * A list of values to be compared against the slug of the Context class passed to isAllowed()
-     *
-     * @var array $acceptable_values
-     */
-    private $acceptable_values;
-
-    /**
-     * Closure that will be called to perform the evaluation within isAllowed().
-     * If none is provided, then a simple type sensitive in_array() check will be used
-     * and return true if the incoming Context::slug() is found within the array of $acceptable_values.
-     *
-     * @var Closure $evaluation_callback
-     */
-    private $evaluation_callback;
-
-
-    /**
-     * ContextChecker constructor.
-     *
-     * @param string       $identifier
-     * @param array        $acceptable_values
-     * @param Closure|null $evaluation_callback [optional]
-     */
-    public function __construct($identifier, array $acceptable_values, Closure $evaluation_callback = null)
-    {
-        $this->setIdentifier($identifier);
-        $this->setAcceptableValues($acceptable_values);
-        $this->setEvaluationCallback($evaluation_callback);
-    }
-
-
-    /**
-     * @param string $identifier
-     */
-    private function setIdentifier($identifier)
-    {
-        $this->identifier = sanitize_key($identifier);
-    }
-
-
-    /**
-     * @param array $acceptable_values
-     */
-    private function setAcceptableValues(array $acceptable_values)
-    {
-        $this->acceptable_values = $acceptable_values;
-    }
-
-
-    /**
-     * @param Closure $evaluation_callback
-     */
-    private function setEvaluationCallback(Closure $evaluation_callback = null)
-    {
-        $this->evaluation_callback = $evaluation_callback instanceof Closure
-            ? $evaluation_callback
-            : function (ContextInterface $context, $acceptable_values) {
-                return in_array($context->slug(), $acceptable_values, true);
-            };
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function identifier()
-    {
-        return $this->identifier;
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function acceptableValues()
-    {
-        return apply_filters(
-            "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__acceptableValues",
-            $this->acceptable_values
-        );
-    }
-
-
-    /**
-     * @return Closure
-     */
-    protected function evaluationCallback()
-    {
-        return $this->evaluation_callback;
-    }
-
-
-    /**
-     * Returns true if the incoming Context class slug matches one of the preset acceptable values.
-     * The result is filterable using the identifier for this ContextChecker.
-     * example:
-     * If this ContextChecker's $identifier was set to "registration-checkout-type",
-     * then the filter here would be named:
-     *  "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed".
-     * Other code could hook into the filter in isAllowed() using the above name
-     * and test for additional acceptable values.
-     * So if the set of $acceptable_values was: [ "initial-visit",  "revisit" ]
-     * then adding a filter to
-     *  "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed",
-     * would allow you to perform your own conditional and allow "wait-list-checkout" as an acceptable value.
-     *  example:
-     *      add_filter(
-     *          'FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed',
-     *          function ($is_allowed, ContextInterface $context) { return $context->slug() === 'wait-list-checkout'
-     *                  ? true
-     *                  : $is_allowed;
-     *          },
-     *          10,
-     *          2
-     *      );
-     *
-     * @param ContextInterface $context
-     * @return boolean
-     */
-    public function isAllowed(ContextInterface $context)
-    {
-        $evaluation_callback = $this->evaluationCallback();
-        return filter_var(
-            apply_filters(
-                "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__isAllowed",
-                $evaluation_callback($context, $this->acceptableValues()),
-                $context,
-                $this
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
+	/**
+	 * A unique string used to identify where this ContextChecker is being employed
+	 * Is currently only used within the hook name for the filterable return value of isAllowed().
+	 *
+	 * @var string $identifier
+	 */
+	private $identifier;
+
+	/**
+	 * A list of values to be compared against the slug of the Context class passed to isAllowed()
+	 *
+	 * @var array $acceptable_values
+	 */
+	private $acceptable_values;
+
+	/**
+	 * Closure that will be called to perform the evaluation within isAllowed().
+	 * If none is provided, then a simple type sensitive in_array() check will be used
+	 * and return true if the incoming Context::slug() is found within the array of $acceptable_values.
+	 *
+	 * @var Closure $evaluation_callback
+	 */
+	private $evaluation_callback;
+
+
+	/**
+	 * ContextChecker constructor.
+	 *
+	 * @param string       $identifier
+	 * @param array        $acceptable_values
+	 * @param Closure|null $evaluation_callback [optional]
+	 */
+	public function __construct($identifier, array $acceptable_values, Closure $evaluation_callback = null)
+	{
+		$this->setIdentifier($identifier);
+		$this->setAcceptableValues($acceptable_values);
+		$this->setEvaluationCallback($evaluation_callback);
+	}
+
+
+	/**
+	 * @param string $identifier
+	 */
+	private function setIdentifier($identifier)
+	{
+		$this->identifier = sanitize_key($identifier);
+	}
+
+
+	/**
+	 * @param array $acceptable_values
+	 */
+	private function setAcceptableValues(array $acceptable_values)
+	{
+		$this->acceptable_values = $acceptable_values;
+	}
+
+
+	/**
+	 * @param Closure $evaluation_callback
+	 */
+	private function setEvaluationCallback(Closure $evaluation_callback = null)
+	{
+		$this->evaluation_callback = $evaluation_callback instanceof Closure
+			? $evaluation_callback
+			: function (ContextInterface $context, $acceptable_values) {
+				return in_array($context->slug(), $acceptable_values, true);
+			};
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function identifier()
+	{
+		return $this->identifier;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function acceptableValues()
+	{
+		return apply_filters(
+			"FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__acceptableValues",
+			$this->acceptable_values
+		);
+	}
+
+
+	/**
+	 * @return Closure
+	 */
+	protected function evaluationCallback()
+	{
+		return $this->evaluation_callback;
+	}
+
+
+	/**
+	 * Returns true if the incoming Context class slug matches one of the preset acceptable values.
+	 * The result is filterable using the identifier for this ContextChecker.
+	 * example:
+	 * If this ContextChecker's $identifier was set to "registration-checkout-type",
+	 * then the filter here would be named:
+	 *  "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed".
+	 * Other code could hook into the filter in isAllowed() using the above name
+	 * and test for additional acceptable values.
+	 * So if the set of $acceptable_values was: [ "initial-visit",  "revisit" ]
+	 * then adding a filter to
+	 *  "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed",
+	 * would allow you to perform your own conditional and allow "wait-list-checkout" as an acceptable value.
+	 *  example:
+	 *      add_filter(
+	 *          'FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed',
+	 *          function ($is_allowed, ContextInterface $context) { return $context->slug() === 'wait-list-checkout'
+	 *                  ? true
+	 *                  : $is_allowed;
+	 *          },
+	 *          10,
+	 *          2
+	 *      );
+	 *
+	 * @param ContextInterface $context
+	 * @return boolean
+	 */
+	public function isAllowed(ContextInterface $context)
+	{
+		$evaluation_callback = $this->evaluationCallback();
+		return filter_var(
+			apply_filters(
+				"FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__isAllowed",
+				$evaluation_callback($context, $this->acceptableValues()),
+				$context,
+				$this
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
 }

core/domain/entities/contexts/ContextInterface.php

Indentation +8 added lines, -8 removed lines

@@ -18,14 +18,14 @@
 interface ContextInterface
 {
 
-    /**
-     * @return string
-     */
-    public function slug();
+	/**
+	 * @return string
+	 */
+	public function slug();
 
 
-    /**
-     * @return string
-     */
-    public function description();
+	/**
+	 * @return string
+	 */
+	public function description();
 }

acceptance_tests/tests/b-TestRegistrationSummaryCept.php

Indentation +41 added lines, -41 removed lines

@@ -14,8 +14,8 @@ 
 
 //need the MER plugin active for this test (we'll deactivate it after).
 $I->ensurePluginActive(
-    'event-espresso-mer-multi-event-registration',
-    'activated'
+	'event-espresso-mer-multi-event-registration',
+	'activated'
 );
 
 //k now we need to make sure the registration multi-status message type is active because it isn't by default
@@ -73,38 +73,38 @@ 
 $I->loginAsAdmin();
 $I->amOnMessagesActivityListTablePage();
 $I->see(
-    'rsm_tester@example.org',
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Multi-status Summary',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Primary Registrant'
-    )
+	'rsm_tester@example.org',
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Multi-status Summary',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Primary Registrant'
+	)
 );
 $I->see(
-    'admin@example.com',
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Multi-status Summary',
-        MessagesAdmin::MESSAGE_STATUS_SENT
-    )
+	'admin@example.com',
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Multi-status Summary',
+		MessagesAdmin::MESSAGE_STATUS_SENT
+	)
 );
 //verify count
 $I->verifyMatchingCountofTextInMessageActivityListTableFor(
-    1,
-    'rsm_tester@example.org',
-    'to',
-    'Registration Multi-status Summary',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Primary Registrant'
+	1,
+	'rsm_tester@example.org',
+	'to',
+	'Registration Multi-status Summary',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Primary Registrant'
 );
 $I->verifyMatchingCountofTextInMessageActivityListTableFor(
-    1,
-    'admin@example.com',
-    'to',
-    'Registration Multi-status Summary'
+	1,
+	'admin@example.com',
+	'to',
+	'Registration Multi-status Summary'
 );
 
 //okay now let's do some registrations for just the first event and verify that registration multi-status summary is NOT
@@ -134,25 +134,25 @@ 
 $I->loginAsAdmin();
 $I->amOnMessagesActivityListTablePage();
 $I->dontSee(
-    'rsm_testerb@example.org',
-    MessagesAdmin::messagesActivityListTableCellSelectorFor(
-        'to',
-        'Registration Multi-status Summary',
-        MessagesAdmin::MESSAGE_STATUS_SENT,
-        '',
-        'Primary Registrant'
-    )
+	'rsm_testerb@example.org',
+	MessagesAdmin::messagesActivityListTableCellSelectorFor(
+		'to',
+		'Registration Multi-status Summary',
+		MessagesAdmin::MESSAGE_STATUS_SENT,
+		'',
+		'Primary Registrant'
+	)
 );
 //there should still only be one admin multi-status summary thing.
 $I->verifyMatchingCountofTextInMessageActivityListTableFor(
-    1,
-    'admin@example.com',
-    'to',
-    'Registration Multi-status Summary'
+	1,
+	'admin@example.com',
+	'to',
+	'Registration Multi-status Summary'
 );
 
 //deactivate MER plugin so its not active for future tests
 $I->ensurePluginDeactivated(
-    'event-espresso-mer-multi-event-registration',
-    'plugins deactivated'
+	'event-espresso-mer-multi-event-registration',
+	'plugins deactivated'
 );
\ No newline at end of file

acceptance_tests/tests/c-TestCustomMessageTemplateCept.php

Indentation +27 added lines, -27 removed lines

@@ -18,14 +18,14 @@ 
 $event_one_link = $event_two_link = $event_three_link = '';
 
 $I->wantTo(
-    'Test that when registrations for multiple events are completed, and those events share the same custom'
-    . 'template, that that custom template will be used.'
+	'Test that when registrations for multiple events are completed, and those events share the same custom'
+	. 'template, that that custom template will be used.'
 );
 
 //need the MER plugin active for this test (we'll deactivate it after).
 $I->ensurePluginActive(
-    'event-espresso-mer-multi-event-registration',
-    'activated'
+	'event-espresso-mer-multi-event-registration',
+	'activated'
 );
 
 $I->loginAsAdmin();
@@ -80,9 +80,9 @@ 
 
 
 $test_registration_details = array(
-    'fname' => 'CTGuy',
-    'lname' => 'Dude',
-    'email' => 'ctguy_dude@example.org'
+	'fname' => 'CTGuy',
+	'lname' => 'Dude',
+	'email' => 'ctguy_dude@example.org'
 );
 
 $I->amGoingTo('Register for Event One and Event Two and verify Custom Template A was used.');
@@ -108,23 +108,23 @@ 
 $I->loginAsAdmin();
 $I->amOnMessagesActivityListTablePage();
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 $I->seeTextInViewMessageModal($custom_template_a_label);
 $I->dismissMessageModal();
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 
 //verify admin context
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved'
+	'Registration Approved'
 );
 $I->seeTextInViewMessageModal($custom_template_a_label);
 $I->dismissMessageModal();
@@ -153,25 +153,25 @@ 
 $I->loginAsAdmin();
 $I->amOnMessagesActivityListTablePage();
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 $I->waitForElementVisible(MessagesAdmin::MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR);
 $I->dontSeeTextInViewMessageModal($custom_template_a_label);
 $I->dontSeeTextInViewMessageModal($custom_template_b_label);
 $I->dismissMessageModal();
 $I->deleteMessageInMessagesListTableFor(
-    'Registration Approved',
-    MessagesAdmin::MESSAGE_STATUS_SENT,
-    'Email',
-    'Registrant'
+	'Registration Approved',
+	MessagesAdmin::MESSAGE_STATUS_SENT,
+	'Email',
+	'Registrant'
 );
 
 //verify admin context
 $I->viewMessageInMessagesListTableFor(
-    'Registration Approved'
+	'Registration Approved'
 );
 $I->waitForElementVisible(MessagesAdmin::MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR);
 $I->dontSee($custom_template_a_label);
@@ -183,6 +183,6 @@ 
 
 //deactivate MER plugin so its not active for future tests
 $I->ensurePluginDeactivated(
-    'event-espresso-mer-multi-event-registration',
-    'plugins deactivated'
+	'event-espresso-mer-multi-event-registration',
+	'plugins deactivated'
 );
\ No newline at end of file