eventespresso / event-espresso-core

core/services/request/middleware/PreProductionVersionWarning.php

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/middleware/DetectLogin.php

Indentation +24 added lines, -24 removed lines

@@ -16,28 +16,28 @@
 class DetectLogin 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;
-        global $pagenow;
-        if (in_array(
-            $pagenow,
-            array('wp-login.php', 'wp-register.php'),
-            true
-        )
-            && ! filter_var($request->getRequestParam('ee_load_on_login'), FILTER_VALIDATE_BOOLEAN)
-        ) {
-            $this->response->terminateRequest();
-        }
-        $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;
+		global $pagenow;
+		if (in_array(
+			$pagenow,
+			array('wp-login.php', 'wp-register.php'),
+			true
+		)
+			&& ! filter_var($request->getRequestParam('ee_load_on_login'), FILTER_VALIDATE_BOOLEAN)
+		) {
+			$this->response->terminateRequest();
+		}
+		$this->response = $this->processRequestStack($this->request, $this->response);
+		return $this->response;
+	}
 }

core/services/request/middleware/Middleware.php

Indentation +41 added lines, -41 removed lines

@@ -25,52 +25,52 @@
 abstract class Middleware implements RequestDecoratorInterface
 {
 
-    /**
-     * @var RequestDecoratorInterface $request_stack_app
-     */
-    protected $request_stack_app;
+	/**
+	 * @var RequestDecoratorInterface $request_stack_app
+	 */
+	protected $request_stack_app;
 
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
 
-    /**
-     * @var ResponseInterface $response
-     */
-    protected $response;
+	/**
+	 * @var ResponseInterface $response
+	 */
+	protected $response;
 
-    /**
-     * @var LoaderInterface
-     */
-    protected $loader;
+	/**
+	 * @var LoaderInterface
+	 */
+	protected $loader;
 
 
-    /**
-     * @param RequestDecoratorInterface $request_stack_app
-     * @param LoaderInterface           $loader
-     */
-    public function __construct(RequestDecoratorInterface $request_stack_app, LoaderInterface $loader)
-    {
-        $this->request_stack_app = $request_stack_app;
-        $this->loader = $loader;
-    }
+	/**
+	 * @param RequestDecoratorInterface $request_stack_app
+	 * @param LoaderInterface           $loader
+	 */
+	public function __construct(RequestDecoratorInterface $request_stack_app, LoaderInterface $loader)
+	{
+		$this->request_stack_app = $request_stack_app;
+		$this->loader = $loader;
+	}
 
 
-    /**
-     * process_request_stack
-     *
-     * @param RequestInterface  $request
-     * @param ResponseInterface $response
-     * @return ResponseInterface
-     */
-    protected function processRequestStack(RequestInterface $request, ResponseInterface $response)
-    {
-        $this->request = $request;
-        $this->response = $response;
-        if (! $this->response->requestTerminated()) {
-            $this->response = $this->request_stack_app->handleRequest($this->request, $this->response);
-        }
-        return $this->response;
-    }
+	/**
+	 * process_request_stack
+	 *
+	 * @param RequestInterface  $request
+	 * @param ResponseInterface $response
+	 * @return ResponseInterface
+	 */
+	protected function processRequestStack(RequestInterface $request, ResponseInterface $response)
+	{
+		$this->request = $request;
+		$this->response = $response;
+		if (! $this->response->requestTerminated()) {
+			$this->response = $this->request_stack_app->handleRequest($this->request, $this->response);
+		}
+		return $this->response;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -68,7 +68,7 @@
     {
         $this->request = $request;
         $this->response = $response;
-        if (! $this->response->requestTerminated()) {
+        if ( ! $this->response->requestTerminated()) {
             $this->response = $this->request_stack_app->handleRequest($this->request, $this->response);
         }
         return $this->response;

core/services/collections/LooseCollection.php

Indentation +31 added lines, -31 removed lines

@@ -16,37 +16,37 @@
 {
 
 
-    /**
-     * setCollectionInterface
-     *
-     * @access protected
-     * @param  string $collection_interface
-     */
-    protected function setCollectionInterface($collection_interface)
-    {
-        $this->collection_interface = '';
-    }
+	/**
+	 * setCollectionInterface
+	 *
+	 * @access protected
+	 * @param  string $collection_interface
+	 */
+	protected function setCollectionInterface($collection_interface)
+	{
+		$this->collection_interface = '';
+	}
 
 
-    /**
-     * add
-     * attaches an object to the Collection
-     * and sets any supplied data associated with the current iterator entry
-     * by calling EE_Object_Collection::set_identifier()
-     *
-     * @access public
-     * @param  mixed $object
-     * @param  mixed $identifier
-     * @return bool
-     * @throws InvalidEntityException
-     */
-    public function add($object, $identifier = null)
-    {
-        if (! is_object($object)) {
-            throw new InvalidEntityException($object, 'object');
-        }
-        $this->attach($object);
-        $this->setIdentifier($object, $identifier);
-        return $this->contains($object);
-    }
+	/**
+	 * add
+	 * attaches an object to the Collection
+	 * and sets any supplied data associated with the current iterator entry
+	 * by calling EE_Object_Collection::set_identifier()
+	 *
+	 * @access public
+	 * @param  mixed $object
+	 * @param  mixed $identifier
+	 * @return bool
+	 * @throws InvalidEntityException
+	 */
+	public function add($object, $identifier = null)
+	{
+		if (! is_object($object)) {
+			throw new InvalidEntityException($object, 'object');
+		}
+		$this->attach($object);
+		$this->setIdentifier($object, $identifier);
+		return $this->contains($object);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
      */
     public function add($object, $identifier = null)
     {
-        if (! is_object($object)) {
+        if ( ! is_object($object)) {
             throw new InvalidEntityException($object, 'object');
         }
         $this->attach($object);

core/services/cache/BasicCacheManager.php

Indentation +130 added lines, -130 removed lines

@@ -16,135 +16,135 @@ 
 class BasicCacheManager implements CacheManagerInterface
 {
 
-    /**
-     * @type string
-     */
-    const CACHE_PREFIX = 'ee_cache_';
-
-
-    /**
-     * @var CacheStorageInterface $cache_storage
-     */
-    private $cache_storage;
-
-
-    /**
-     * BasicCacheManager constructor.
-     *
-     * @param CacheStorageInterface $cache_storage [required]
-     */
-    public function __construct(CacheStorageInterface $cache_storage)
-    {
-        $this->cache_storage = $cache_storage;
-    }
-
-
-    /**
-     * returns a string that will be prepended to all cache identifiers
-     *
-     * @return string
-     */
-    public function cachePrefix()
-    {
-        return BasicCacheManager::CACHE_PREFIX;
-    }
-
-
-    /**
-     * @param string  $id_prefix [required] Prepended to all cache IDs. Can be helpful in finding specific cache types.
-     *                           May also be helpful to include an additional specific identifier,
-     *                           such as a post ID as part of the $id_prefix so that individual caches
-     *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
-     *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
-     * @param string  $cache_id  [required] Additional identifying details that make this cache unique.
-     *                           It is advisable to use some of the actual data
-     *                           that is used to generate the content being cached,
-     *                           in order to guarantee that the cache id is unique for that content.
-     *                           The cache id will be md5'd before usage to make it more db friendly,
-     *                           and the entire cache id string will be truncated to 190 characters.
-     * @param Closure $callback  [required] since the point of caching is to avoid generating content when not
-     *                           necessary,
-     *                           we wrap our content creation in a Closure so that it is not executed until needed.
-     * @param int     $expiration
-     * @return Closure|mixed
-     */
-    public function get($id_prefix, $cache_id, Closure $callback, $expiration = HOUR_IN_SECONDS)
-    {
-        $content = '';
-        $expiration = absint(
-            apply_filters(
-                'FHEE__CacheManager__get__cache_expiration',
-                $expiration,
-                $id_prefix,
-                $cache_id
-            )
-        );
-        $cache_id = $this->generateCacheIdentifier($id_prefix, $cache_id);
-        // is caching enabled for this content ?
-        if ($expiration) {
-            $content = $this->cache_storage->get($cache_id);
-        }
-        // any existing content ?
-        if (empty($content)) {
-            // nope! let's generate some new stuff
-            $content = $callback();
-            // save the new content if caching is enabled
-            if ($expiration) {
-                $this->cache_storage->add($cache_id, $content, $expiration);
-                if (EE_DEBUG) {
-                    $content .= $this->displayCacheNotice($cache_id, 'REFRESH CACHE');
-                }
-            }
-        } else {
-            if (EE_DEBUG) {
-                $content .= $this->displayCacheNotice($cache_id, 'CACHED CONTENT');
-            }
-        }
-        return $content;
-    }
-
-
-    /**
-     * Generates a unique identifier string for the cache
-     *
-     * @param string $id_prefix [required] see BasicCacheManager::get()
-     * @param string $cache_id  [required] see BasicCacheManager::get()
-     * @return string
-     */
-    private function generateCacheIdentifier($id_prefix, $cache_id)
-    {
-        // let's make the cached content unique for this "page"
-        $cache_id .= filter_input(INPUT_SERVER, 'REQUEST_URI', FILTER_SANITIZE_URL);
-        // with these parameters
-        $cache_id .= filter_input(INPUT_SERVER, 'QUERY_STRING', FILTER_SANITIZE_URL);
-        // then md5 the above to control it's length, add all of our prefixes, and truncate
-        return substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182);
-    }
-
-
-    /**
-     * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
-     *                               or a specific ID targeting a single cache item
-     * @return void
-     */
-    public function clear($cache_id)
-    {
-        // ensure incoming arg is in an array
-        $cache_id = is_array($cache_id) ? $cache_id : array($cache_id);
-        // delete corresponding transients for the supplied id prefix
-        $this->cache_storage->deleteMany($cache_id);
-    }
-
-
-    /**
-     * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
-     *                               or a specific ID targeting a single cache item
-     * @param string       $type
-     * @return string
-     */
-    private function displayCacheNotice($cache_id, $type)
-    {
-        return '
+	/**
+	 * @type string
+	 */
+	const CACHE_PREFIX = 'ee_cache_';
+
+
+	/**
+	 * @var CacheStorageInterface $cache_storage
+	 */
+	private $cache_storage;
+
+
+	/**
+	 * BasicCacheManager constructor.
+	 *
+	 * @param CacheStorageInterface $cache_storage [required]
+	 */
+	public function __construct(CacheStorageInterface $cache_storage)
+	{
+		$this->cache_storage = $cache_storage;
+	}
+
+
+	/**
+	 * returns a string that will be prepended to all cache identifiers
+	 *
+	 * @return string
+	 */
+	public function cachePrefix()
+	{
+		return BasicCacheManager::CACHE_PREFIX;
+	}
+
+
+	/**
+	 * @param string  $id_prefix [required] Prepended to all cache IDs. Can be helpful in finding specific cache types.
+	 *                           May also be helpful to include an additional specific identifier,
+	 *                           such as a post ID as part of the $id_prefix so that individual caches
+	 *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
+	 *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
+	 * @param string  $cache_id  [required] Additional identifying details that make this cache unique.
+	 *                           It is advisable to use some of the actual data
+	 *                           that is used to generate the content being cached,
+	 *                           in order to guarantee that the cache id is unique for that content.
+	 *                           The cache id will be md5'd before usage to make it more db friendly,
+	 *                           and the entire cache id string will be truncated to 190 characters.
+	 * @param Closure $callback  [required] since the point of caching is to avoid generating content when not
+	 *                           necessary,
+	 *                           we wrap our content creation in a Closure so that it is not executed until needed.
+	 * @param int     $expiration
+	 * @return Closure|mixed
+	 */
+	public function get($id_prefix, $cache_id, Closure $callback, $expiration = HOUR_IN_SECONDS)
+	{
+		$content = '';
+		$expiration = absint(
+			apply_filters(
+				'FHEE__CacheManager__get__cache_expiration',
+				$expiration,
+				$id_prefix,
+				$cache_id
+			)
+		);
+		$cache_id = $this->generateCacheIdentifier($id_prefix, $cache_id);
+		// is caching enabled for this content ?
+		if ($expiration) {
+			$content = $this->cache_storage->get($cache_id);
+		}
+		// any existing content ?
+		if (empty($content)) {
+			// nope! let's generate some new stuff
+			$content = $callback();
+			// save the new content if caching is enabled
+			if ($expiration) {
+				$this->cache_storage->add($cache_id, $content, $expiration);
+				if (EE_DEBUG) {
+					$content .= $this->displayCacheNotice($cache_id, 'REFRESH CACHE');
+				}
+			}
+		} else {
+			if (EE_DEBUG) {
+				$content .= $this->displayCacheNotice($cache_id, 'CACHED CONTENT');
+			}
+		}
+		return $content;
+	}
+
+
+	/**
+	 * Generates a unique identifier string for the cache
+	 *
+	 * @param string $id_prefix [required] see BasicCacheManager::get()
+	 * @param string $cache_id  [required] see BasicCacheManager::get()
+	 * @return string
+	 */
+	private function generateCacheIdentifier($id_prefix, $cache_id)
+	{
+		// let's make the cached content unique for this "page"
+		$cache_id .= filter_input(INPUT_SERVER, 'REQUEST_URI', FILTER_SANITIZE_URL);
+		// with these parameters
+		$cache_id .= filter_input(INPUT_SERVER, 'QUERY_STRING', FILTER_SANITIZE_URL);
+		// then md5 the above to control it's length, add all of our prefixes, and truncate
+		return substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182);
+	}
+
+
+	/**
+	 * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
+	 *                               or a specific ID targeting a single cache item
+	 * @return void
+	 */
+	public function clear($cache_id)
+	{
+		// ensure incoming arg is in an array
+		$cache_id = is_array($cache_id) ? $cache_id : array($cache_id);
+		// delete corresponding transients for the supplied id prefix
+		$this->cache_storage->deleteMany($cache_id);
+	}
+
+
+	/**
+	 * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
+	 *                               or a specific ID targeting a single cache item
+	 * @param string       $type
+	 * @return string
+	 */
+	private function displayCacheNotice($cache_id, $type)
+	{
+		return '
 <div class="ee-cached-content-notice" style="position:fixed; bottom:0; left: 0;">
     <p style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;margin:0 0 3px 5px">
         <b>' . $type . '</b><span style="color:#999"> : </span>
@@ -152,5 +152,5 @@ 
         <span style="margin-left:2em;">' . __FILE__ . '</span>
     </p>
 </div>';
-    }
+	}
 }

core/services/notices/ConvertNoticesToAdminNotices.php

Indentation +38 added lines, -38 removed lines

@@ -14,42 +14,42 @@
 class ConvertNoticesToAdminNotices extends NoticeConverter
 {
 
-    /**
-     * Converts Notice objects into AdminNotice notifications
-     *
-     * @param NoticesContainerInterface $notices
-     * @throws DomainException
-     */
-    public function process(NoticesContainerInterface $notices)
-    {
-        if ($notices->hasAttention()) {
-            foreach ($notices->getAttention() as $notice) {
-                new AdminNotice($notice);
-            }
-        }
-        if ($notices->hasError()) {
-            $error_string = esc_html__('The following errors occurred:', 'event_espresso');
-            foreach ($notices->getError() as $notice) {
-                if ($this->getThrowExceptions()) {
-                    $error_string .= '<br />' . $notice->message();
-                } else {
-                    new AdminNotice($notice);
-                }
-            }
-            if ($this->getThrowExceptions()) {
-                throw new DomainException($error_string);
-            }
-        }
-        if ($notices->hasSuccess()) {
-            foreach ($notices->getSuccess() as $notice) {
-                new AdminNotice($notice);
-            }
-        }
-        if ($notices->hasInformation()) {
-            foreach ($notices->getInformation() as $notice) {
-                new AdminNotice($notice);
-            }
-        }
-        $this->clearNotices();
-    }
+	/**
+	 * Converts Notice objects into AdminNotice notifications
+	 *
+	 * @param NoticesContainerInterface $notices
+	 * @throws DomainException
+	 */
+	public function process(NoticesContainerInterface $notices)
+	{
+		if ($notices->hasAttention()) {
+			foreach ($notices->getAttention() as $notice) {
+				new AdminNotice($notice);
+			}
+		}
+		if ($notices->hasError()) {
+			$error_string = esc_html__('The following errors occurred:', 'event_espresso');
+			foreach ($notices->getError() as $notice) {
+				if ($this->getThrowExceptions()) {
+					$error_string .= '<br />' . $notice->message();
+				} else {
+					new AdminNotice($notice);
+				}
+			}
+			if ($this->getThrowExceptions()) {
+				throw new DomainException($error_string);
+			}
+		}
+		if ($notices->hasSuccess()) {
+			foreach ($notices->getSuccess() as $notice) {
+				new AdminNotice($notice);
+			}
+		}
+		if ($notices->hasInformation()) {
+			foreach ($notices->getInformation() as $notice) {
+				new AdminNotice($notice);
+			}
+		}
+		$this->clearNotices();
+	}
 }

core/services/notices/NoticeConverter.php

Indentation +67 added lines, -67 removed lines

@@ -12,71 +12,71 @@
 abstract class NoticeConverter implements NoticeConverterInterface
 {
 
-    /**
-     * @var NoticesContainerInterface $notices
-     */
-    private $notices;
-
-    /**
-     * if set to true, then errors will be thrown as exceptions
-     *
-     * @var boolean $throw_exceptions
-     */
-    private $throw_exceptions;
-
-
-    /**
-     * NoticeConverter constructor.
-     *
-     * @param bool $throw_exceptions
-     */
-    public function __construct($throw_exceptions = false)
-    {
-        $this->throw_exceptions = $throw_exceptions;
-    }
-
-
-    /**
-     * @return NoticesContainerInterface
-     */
-    public function getNotices()
-    {
-        return $this->notices;
-    }
-
-
-    /**
-     * @param NoticesContainerInterface $notices
-     */
-    protected function setNotices(NoticesContainerInterface $notices)
-    {
-        $this->notices = $notices;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function getThrowExceptions()
-    {
-        return $this->throw_exceptions;
-    }
-
-
-    /**
-     * @param bool $throw_exceptions
-     */
-    public function setThrowExceptions($throw_exceptions)
-    {
-        $this->throw_exceptions = filter_var($throw_exceptions, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return void;
-     */
-    public function clearNotices()
-    {
-        $this->notices = null;
-    }
+	/**
+	 * @var NoticesContainerInterface $notices
+	 */
+	private $notices;
+
+	/**
+	 * if set to true, then errors will be thrown as exceptions
+	 *
+	 * @var boolean $throw_exceptions
+	 */
+	private $throw_exceptions;
+
+
+	/**
+	 * NoticeConverter constructor.
+	 *
+	 * @param bool $throw_exceptions
+	 */
+	public function __construct($throw_exceptions = false)
+	{
+		$this->throw_exceptions = $throw_exceptions;
+	}
+
+
+	/**
+	 * @return NoticesContainerInterface
+	 */
+	public function getNotices()
+	{
+		return $this->notices;
+	}
+
+
+	/**
+	 * @param NoticesContainerInterface $notices
+	 */
+	protected function setNotices(NoticesContainerInterface $notices)
+	{
+		$this->notices = $notices;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function getThrowExceptions()
+	{
+		return $this->throw_exceptions;
+	}
+
+
+	/**
+	 * @param bool $throw_exceptions
+	 */
+	public function setThrowExceptions($throw_exceptions)
+	{
+		$this->throw_exceptions = filter_var($throw_exceptions, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return void;
+	 */
+	public function clearNotices()
+	{
+		$this->notices = null;
+	}
 }

core/services/notices/AdminNotice.php

Indentation +115 added lines, -115 removed lines

@@ -13,119 +13,119 @@
 class AdminNotice
 {
 
-    const ERROR = 'notice-error';
-
-    const WARNING = 'notice-warning';
-
-    const SUCCESS = 'notice-success';
-
-    const INFORMATION = 'notice-info';
-
-    const DISMISSABLE = ' is-dismissible';
-
-    /**
-     * generic system notice to be converted into a WP admin notice
-     *
-     * @var NoticeInterface $notice
-     */
-    private $notice;
-
-
-    /**
-     * AdminNotice constructor.
-     *
-     * @param NoticeInterface $notice
-     * @param bool            $display_now
-     */
-    public function __construct(NoticeInterface $notice, $display_now = true)
-    {
-        $this->notice = $notice;
-        if (! did_action('admin_notices')) {
-            add_action('admin_notices', array($this, 'displayNotice'));
-        } elseif ($display_now) {
-            $this->displayNotice();
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    public function displayNotice()
-    {
-        echo $this->getNotice();
-    }
-
-
-    /**
-     * produces something  like:
-     *  <div class="notice notice-success is-dismissible event-espresso-admin-notice">
-     *      <p>YOU DID IT!</p>
-     *      <button type="button" class="notice-dismiss"><span class="screen-reader-text">Dismiss this
-     *      notice.</span></button>
-     *  </div>
-     *
-     * @return string
-     */
-    public function getNotice()
-    {
-        return sprintf(
-            '<div class="notice %1$s%2$s event-espresso-admin-notice"><p>%3$s</p></div>',
-            $this->getType(),
-            $this->notice->isDismissible() ? AdminNotice::DISMISSABLE : '',
-            $this->getMessage()
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    private function getType()
-    {
-        switch ($this->notice->type()) {
-            case Notice::ERROR:
-                return AdminNotice::ERROR;
-                break;
-            case Notice::ATTENTION:
-                return AdminNotice::WARNING;
-                break;
-            case Notice::SUCCESS:
-                return AdminNotice::SUCCESS;
-                break;
-            case Notice::INFORMATION:
-            default:
-                return AdminNotice::INFORMATION;
-                break;
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function getMessage()
-    {
-        $message = $this->notice->message();
-        if (WP_DEBUG && $this->getType() === AdminNotice::ERROR) {
-            $message .= '<br/><span class="tiny-text">' . $this->generateErrorCode() . '</span>';
-        }
-        return $message;
-    }
-
-
-    /**
-     * create error code from filepath, function name,
-     * and line number where notice was generated
-     *
-     * @return string
-     */
-    protected function generateErrorCode()
-    {
-        $file = explode('.', basename($this->notice->file()));
-        $error_code = ! empty($file[0]) ? $file[0] : '';
-        $error_code .= ! empty($error_code) ? ' - ' . $this->notice->func() : $this->notice->func();
-        $error_code .= ' - ' . $this->notice->line();
-        return $error_code;
-    }
+	const ERROR = 'notice-error';
+
+	const WARNING = 'notice-warning';
+
+	const SUCCESS = 'notice-success';
+
+	const INFORMATION = 'notice-info';
+
+	const DISMISSABLE = ' is-dismissible';
+
+	/**
+	 * generic system notice to be converted into a WP admin notice
+	 *
+	 * @var NoticeInterface $notice
+	 */
+	private $notice;
+
+
+	/**
+	 * AdminNotice constructor.
+	 *
+	 * @param NoticeInterface $notice
+	 * @param bool            $display_now
+	 */
+	public function __construct(NoticeInterface $notice, $display_now = true)
+	{
+		$this->notice = $notice;
+		if (! did_action('admin_notices')) {
+			add_action('admin_notices', array($this, 'displayNotice'));
+		} elseif ($display_now) {
+			$this->displayNotice();
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function displayNotice()
+	{
+		echo $this->getNotice();
+	}
+
+
+	/**
+	 * produces something  like:
+	 *  <div class="notice notice-success is-dismissible event-espresso-admin-notice">
+	 *      <p>YOU DID IT!</p>
+	 *      <button type="button" class="notice-dismiss"><span class="screen-reader-text">Dismiss this
+	 *      notice.</span></button>
+	 *  </div>
+	 *
+	 * @return string
+	 */
+	public function getNotice()
+	{
+		return sprintf(
+			'<div class="notice %1$s%2$s event-espresso-admin-notice"><p>%3$s</p></div>',
+			$this->getType(),
+			$this->notice->isDismissible() ? AdminNotice::DISMISSABLE : '',
+			$this->getMessage()
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	private function getType()
+	{
+		switch ($this->notice->type()) {
+			case Notice::ERROR:
+				return AdminNotice::ERROR;
+				break;
+			case Notice::ATTENTION:
+				return AdminNotice::WARNING;
+				break;
+			case Notice::SUCCESS:
+				return AdminNotice::SUCCESS;
+				break;
+			case Notice::INFORMATION:
+			default:
+				return AdminNotice::INFORMATION;
+				break;
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function getMessage()
+	{
+		$message = $this->notice->message();
+		if (WP_DEBUG && $this->getType() === AdminNotice::ERROR) {
+			$message .= '<br/><span class="tiny-text">' . $this->generateErrorCode() . '</span>';
+		}
+		return $message;
+	}
+
+
+	/**
+	 * create error code from filepath, function name,
+	 * and line number where notice was generated
+	 *
+	 * @return string
+	 */
+	protected function generateErrorCode()
+	{
+		$file = explode('.', basename($this->notice->file()));
+		$error_code = ! empty($file[0]) ? $file[0] : '';
+		$error_code .= ! empty($error_code) ? ' - ' . $this->notice->func() : $this->notice->func();
+		$error_code .= ' - ' . $this->notice->line();
+		return $error_code;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -40,7 +40,7 @@ 
     public function __construct(NoticeInterface $notice, $display_now = true)
     {
         $this->notice = $notice;
-        if (! did_action('admin_notices')) {
+        if ( ! did_action('admin_notices')) {
             add_action('admin_notices', array($this, 'displayNotice'));
         } elseif ($display_now) {
             $this->displayNotice();
@@ -108,7 +108,7 @@ 
     {
         $message = $this->notice->message();
         if (WP_DEBUG && $this->getType() === AdminNotice::ERROR) {
-            $message .= '<br/><span class="tiny-text">' . $this->generateErrorCode() . '</span>';
+            $message .= '<br/><span class="tiny-text">'.$this->generateErrorCode().'</span>';
         }
         return $message;
     }
@@ -124,8 +124,8 @@ 
     {
         $file = explode('.', basename($this->notice->file()));
         $error_code = ! empty($file[0]) ? $file[0] : '';
-        $error_code .= ! empty($error_code) ? ' - ' . $this->notice->func() : $this->notice->func();
-        $error_code .= ' - ' . $this->notice->line();
+        $error_code .= ! empty($error_code) ? ' - '.$this->notice->func() : $this->notice->func();
+        $error_code .= ' - '.$this->notice->line();
         return $error_code;
     }
 }

core/services/notices/NoticesContainer.php

Indentation +214 added lines, -214 removed lines

@@ -15,218 +15,218 @@
 {
 
 
-    /**
-     * @var NoticeInterface[] $information
-     */
-    private $information = array();
-
-
-    /**
-     * @var NoticeInterface[] $attention
-     */
-    private $attention = array();
-
-
-    /**
-     * @var NoticeInterface[] $error
-     */
-    private $error = array();
-
-
-    /**
-     * @var NoticeInterface[] $success
-     */
-    private $success = array();
-
-
-    /**
-     * @param string $notice
-     * @param bool   $dismissible
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @throws InvalidDataTypeException
-     */
-    public function addInformation($notice, $dismissible = true, $file = '', $func = '', $line = '')
-    {
-        $this->information[] = new Notice(
-            Notice::INFORMATION,
-            $notice,
-            $dismissible,
-            $file,
-            $func,
-            $line
-        );
-    }
-
-
-    /**
-     * @param string $notice
-     * @param bool   $dismissible
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @throws InvalidDataTypeException
-     */
-    public function addAttention($notice, $dismissible = true, $file = '', $func = '', $line = '')
-    {
-        $this->attention[] = new Notice(
-            Notice::ATTENTION,
-            $notice,
-            $dismissible,
-            $file,
-            $func,
-            $line
-        );
-    }
-
-    // phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
-    /**
-     * @param string $notice
-     * @param bool   $dismissible
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @throws InvalidDataTypeException
-     */
-    public function addError($notice, $dismissible = true, $file, $func, $line)
-    {
-        $this->error[] = new Notice(
-            Notice::ERROR,
-            $notice,
-            $dismissible,
-            $file,
-            $func,
-            $line
-        );
-    }
-
-
-    /**
-     * @param string $notice
-     * @param bool   $dismissible
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @throws InvalidDataTypeException
-     */
-    public function addSuccess($notice, $dismissible = true, $file = '', $func = '', $line = '')
-    {
-        $this->success[] = new Notice(
-            Notice::SUCCESS,
-            $notice,
-            $dismissible,
-            $file,
-            $func,
-            $line
-        );
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function hasInformation()
-    {
-        return ! empty($this->information);
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function hasAttention()
-    {
-        return ! empty($this->attention);
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function hasError()
-    {
-        return ! empty($this->error);
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function hasSuccess()
-    {
-        return ! empty($this->success);
-    }
-
-
-    /**
-     * @return int
-     */
-    public function countInformation()
-    {
-        return count($this->information);
-    }
-
-
-    /**
-     * @return int
-     */
-    public function countAttention()
-    {
-        return count($this->attention);
-    }
-
-
-    /**
-     * @return int
-     */
-    public function countError()
-    {
-        return count($this->error);
-    }
-
-
-    /**
-     * @return int
-     */
-    public function countSuccess()
-    {
-        return count($this->success);
-    }
-
-
-    /**
-     * @return NoticeInterface[]
-     */
-    public function getInformation()
-    {
-        return $this->information;
-    }
-
-
-    /**
-     * @return NoticeInterface[]
-     */
-    public function getAttention()
-    {
-        return $this->attention;
-    }
-
-
-    /**
-     * @return NoticeInterface[]
-     */
-    public function getError()
-    {
-        return $this->error;
-    }
-
-
-    /**
-     * @return NoticeInterface[]
-     */
-    public function getSuccess()
-    {
-        return $this->success;
-    }
+	/**
+	 * @var NoticeInterface[] $information
+	 */
+	private $information = array();
+
+
+	/**
+	 * @var NoticeInterface[] $attention
+	 */
+	private $attention = array();
+
+
+	/**
+	 * @var NoticeInterface[] $error
+	 */
+	private $error = array();
+
+
+	/**
+	 * @var NoticeInterface[] $success
+	 */
+	private $success = array();
+
+
+	/**
+	 * @param string $notice
+	 * @param bool   $dismissible
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @throws InvalidDataTypeException
+	 */
+	public function addInformation($notice, $dismissible = true, $file = '', $func = '', $line = '')
+	{
+		$this->information[] = new Notice(
+			Notice::INFORMATION,
+			$notice,
+			$dismissible,
+			$file,
+			$func,
+			$line
+		);
+	}
+
+
+	/**
+	 * @param string $notice
+	 * @param bool   $dismissible
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @throws InvalidDataTypeException
+	 */
+	public function addAttention($notice, $dismissible = true, $file = '', $func = '', $line = '')
+	{
+		$this->attention[] = new Notice(
+			Notice::ATTENTION,
+			$notice,
+			$dismissible,
+			$file,
+			$func,
+			$line
+		);
+	}
+
+	// phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
+	/**
+	 * @param string $notice
+	 * @param bool   $dismissible
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @throws InvalidDataTypeException
+	 */
+	public function addError($notice, $dismissible = true, $file, $func, $line)
+	{
+		$this->error[] = new Notice(
+			Notice::ERROR,
+			$notice,
+			$dismissible,
+			$file,
+			$func,
+			$line
+		);
+	}
+
+
+	/**
+	 * @param string $notice
+	 * @param bool   $dismissible
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @throws InvalidDataTypeException
+	 */
+	public function addSuccess($notice, $dismissible = true, $file = '', $func = '', $line = '')
+	{
+		$this->success[] = new Notice(
+			Notice::SUCCESS,
+			$notice,
+			$dismissible,
+			$file,
+			$func,
+			$line
+		);
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function hasInformation()
+	{
+		return ! empty($this->information);
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function hasAttention()
+	{
+		return ! empty($this->attention);
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function hasError()
+	{
+		return ! empty($this->error);
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function hasSuccess()
+	{
+		return ! empty($this->success);
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function countInformation()
+	{
+		return count($this->information);
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function countAttention()
+	{
+		return count($this->attention);
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function countError()
+	{
+		return count($this->error);
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function countSuccess()
+	{
+		return count($this->success);
+	}
+
+
+	/**
+	 * @return NoticeInterface[]
+	 */
+	public function getInformation()
+	{
+		return $this->information;
+	}
+
+
+	/**
+	 * @return NoticeInterface[]
+	 */
+	public function getAttention()
+	{
+		return $this->attention;
+	}
+
+
+	/**
+	 * @return NoticeInterface[]
+	 */
+	public function getError()
+	{
+		return $this->error;
+	}
+
+
+	/**
+	 * @return NoticeInterface[]
+	 */
+	public function getSuccess()
+	{
+		return $this->success;
+	}
 }