eventespresso / event-espresso-core

core/domain/entities/routing/handlers/Route.php

Indentation +129 added lines, -129 removed lines

@@ -23,133 +23,133 @@
 abstract class Route implements RouteInterface
 {
 
-    // /** will most likely need this for routing so pencilled it in for now
-    //  * @type CommandBusInterface $command_bus
-    //  */
-    // protected $command_bus;
-
-    /**
-     * @var EE_Dependency_Map $dependency_map
-     */
-    protected $dependency_map;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-    /**
-     * @var RouteMatchSpecificationInterface $specification
-     */
-    private $specification;
-
-    /**
-     * @var boolean $handled
-     */
-    private $handled = false;
-
-
-    /**
-     * Route constructor.
-     *
-     * @param EE_Dependency_Map                $dependency_map
-     * @param LoaderInterface                  $loader
-     * @param RequestInterface                 $request
-     * @param RouteMatchSpecificationInterface $specification
-     */
-    public function __construct(
-        EE_Dependency_Map $dependency_map,
-        LoaderInterface $loader,
-        RequestInterface $request,
-        RouteMatchSpecificationInterface $specification = null
-    ) {
-        $this->dependency_map = $dependency_map;
-        $this->loader = $loader;
-        $this->request = $request;
-        $this->specification = $specification;
-    }
-
-
-    /**
-     * @since $VID:$
-     */
-    abstract protected function registerDependencies();
-
-
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    abstract protected function requestHandler();
-
-
-    /**
-     * returns true if the current request matches this route
-     * child classes can override and use Request directly to match route with request
-     * or supply a RouteMatchSpecification class and just use the below
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    public function matchesCurrentRequest()
-    {
-        return $this->specification instanceof RouteMatchSpecificationInterface
-            ? $this->specification->isMatchingRoute()
-            : false;
-    }
-
-
-    /**
-     * @return bool
-     */
-    final public function isHandled()
-    {
-        return $this->handled;
-    }
-
-
-    /**
-     * @param bool $handled
-     */
-    private function setHandled($handled)
-    {
-        $this->handled = filter_var($handled, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * runs route requestHandler() if
-     *      - route has not previously been handled
-     *      - route specification matches for current request
-     * sets route handled property based on results returned by requestHandler()
-     *
-     * @return bool
-     * @throws DomainException
-     * @since   $VID:$
-     */
-    final public function handleRequest()
-    {
-        if (! $this->isHandled() && $this->matchesCurrentRequest()) {
-            do_action('AHEE__EventEspresso_core_domain_entities_routes_handlers_Route__handleRequest', $this);
-            $this->registerDependencies();
-            $handled = $this->requestHandler();
-            if (! is_bool($handled)) {
-                throw new DomainException(
-                    esc_html__(
-                        'Route::requestHandler() must return a boolean to indicate whether the request has been handled or not.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $this->setHandled($handled);
-        }
-        return $this->handled;
-    }
+	// /** will most likely need this for routing so pencilled it in for now
+	//  * @type CommandBusInterface $command_bus
+	//  */
+	// protected $command_bus;
+
+	/**
+	 * @var EE_Dependency_Map $dependency_map
+	 */
+	protected $dependency_map;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+	/**
+	 * @var RouteMatchSpecificationInterface $specification
+	 */
+	private $specification;
+
+	/**
+	 * @var boolean $handled
+	 */
+	private $handled = false;
+
+
+	/**
+	 * Route constructor.
+	 *
+	 * @param EE_Dependency_Map                $dependency_map
+	 * @param LoaderInterface                  $loader
+	 * @param RequestInterface                 $request
+	 * @param RouteMatchSpecificationInterface $specification
+	 */
+	public function __construct(
+		EE_Dependency_Map $dependency_map,
+		LoaderInterface $loader,
+		RequestInterface $request,
+		RouteMatchSpecificationInterface $specification = null
+	) {
+		$this->dependency_map = $dependency_map;
+		$this->loader = $loader;
+		$this->request = $request;
+		$this->specification = $specification;
+	}
+
+
+	/**
+	 * @since $VID:$
+	 */
+	abstract protected function registerDependencies();
+
+
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	abstract protected function requestHandler();
+
+
+	/**
+	 * returns true if the current request matches this route
+	 * child classes can override and use Request directly to match route with request
+	 * or supply a RouteMatchSpecification class and just use the below
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	public function matchesCurrentRequest()
+	{
+		return $this->specification instanceof RouteMatchSpecificationInterface
+			? $this->specification->isMatchingRoute()
+			: false;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	final public function isHandled()
+	{
+		return $this->handled;
+	}
+
+
+	/**
+	 * @param bool $handled
+	 */
+	private function setHandled($handled)
+	{
+		$this->handled = filter_var($handled, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * runs route requestHandler() if
+	 *      - route has not previously been handled
+	 *      - route specification matches for current request
+	 * sets route handled property based on results returned by requestHandler()
+	 *
+	 * @return bool
+	 * @throws DomainException
+	 * @since   $VID:$
+	 */
+	final public function handleRequest()
+	{
+		if (! $this->isHandled() && $this->matchesCurrentRequest()) {
+			do_action('AHEE__EventEspresso_core_domain_entities_routes_handlers_Route__handleRequest', $this);
+			$this->registerDependencies();
+			$handled = $this->requestHandler();
+			if (! is_bool($handled)) {
+				throw new DomainException(
+					esc_html__(
+						'Route::requestHandler() must return a boolean to indicate whether the request has been handled or not.',
+						'event_espresso'
+					)
+				);
+			}
+			$this->setHandled($handled);
+		}
+		return $this->handled;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -136,11 +136,11 @@
      */
     final public function handleRequest()
     {
-        if (! $this->isHandled() && $this->matchesCurrentRequest()) {
+        if ( ! $this->isHandled() && $this->matchesCurrentRequest()) {
             do_action('AHEE__EventEspresso_core_domain_entities_routes_handlers_Route__handleRequest', $this);
             $this->registerDependencies();
             $handled = $this->requestHandler();
-            if (! is_bool($handled)) {
+            if ( ! is_bool($handled)) {
                 throw new DomainException(
                     esc_html__(
                         'Route::requestHandler() must return a boolean to indicate whether the request has been handled or not.',

core/domain/entities/routing/handlers/RouteInterface.php

Indentation +18 added lines, -18 removed lines

@@ -14,24 +14,24 @@
 interface RouteInterface
 {
 
-    /**
-     * final method called by RouteHandler on Route which in turn calls requestHandler()
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    public function handleRequest();
+	/**
+	 * final method called by RouteHandler on Route which in turn calls requestHandler()
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	public function handleRequest();
 
-    /**
-     * @return bool
-     */
-    public function isHandled();
+	/**
+	 * @return bool
+	 */
+	public function isHandled();
 
-    /**
-     * returns true if the current request matches this route
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    public function matchesCurrentRequest();
+	/**
+	 * returns true if the current request matches this route
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	public function matchesCurrentRequest();
 }

core/domain/entities/routing/handlers/frontend/FrontendRequests.php

Indentation +59 added lines, -59 removed lines

@@ -19,71 +19,71 @@
 class FrontendRequests extends Route
 {
 
-    /**
-     * @var EE_Maintenance_Mode $maintenance_mode
-     */
-    private $maintenance_mode;
+	/**
+	 * @var EE_Maintenance_Mode $maintenance_mode
+	 */
+	private $maintenance_mode;
 
 
-    /**
-     * returns true if the current request matches this route
-     * child classes can override and use Request directly to match route with request
-     * or supply a RouteMatchSpecification class and just use the below
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    public function matchesCurrentRequest()
-    {
-        return ($this->request->isFrontend() || $this->request->isFrontAjax()) && ! $this->maintenance_mode->level();
-    }
+	/**
+	 * returns true if the current request matches this route
+	 * child classes can override and use Request directly to match route with request
+	 * or supply a RouteMatchSpecification class and just use the below
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	public function matchesCurrentRequest()
+	{
+		return ($this->request->isFrontend() || $this->request->isFrontAjax()) && ! $this->maintenance_mode->level();
+	}
 
 
-    /**
-     * FrontendRequests constructor.
-     *
-     * @param EE_Dependency_Map   $dependency_map
-     * @param EE_Maintenance_Mode $maintenance_mode
-     * @param LoaderInterface     $loader
-     * @param RequestInterface    $request
-     */
-    public function __construct(
-        EE_Dependency_Map $dependency_map,
-        EE_Maintenance_Mode $maintenance_mode,
-        LoaderInterface $loader,
-        RequestInterface $request
-    ) {
-        $this->maintenance_mode = $maintenance_mode;
-        parent::__construct($dependency_map, $loader, $request);
-    }
+	/**
+	 * FrontendRequests constructor.
+	 *
+	 * @param EE_Dependency_Map   $dependency_map
+	 * @param EE_Maintenance_Mode $maintenance_mode
+	 * @param LoaderInterface     $loader
+	 * @param RequestInterface    $request
+	 */
+	public function __construct(
+		EE_Dependency_Map $dependency_map,
+		EE_Maintenance_Mode $maintenance_mode,
+		LoaderInterface $loader,
+		RequestInterface $request
+	) {
+		$this->maintenance_mode = $maintenance_mode;
+		parent::__construct($dependency_map, $loader, $request);
+	}
 
 
-    /**
-     * @since $VID:$
-     */
-    protected function registerDependencies()
-    {
-        $this->dependency_map->registerDependencies(
-            'EE_Front_Controller',
-            [
-                'EE_Registry'              => EE_Dependency_Map::load_from_cache,
-                'EE_Request_Handler'       => EE_Dependency_Map::load_from_cache,
-                'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-    }
+	/**
+	 * @since $VID:$
+	 */
+	protected function registerDependencies()
+	{
+		$this->dependency_map->registerDependencies(
+			'EE_Front_Controller',
+			[
+				'EE_Registry'              => EE_Dependency_Map::load_from_cache,
+				'EE_Request_Handler'       => EE_Dependency_Map::load_from_cache,
+				'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+	}
 
 
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    protected function requestHandler()
-    {
-        do_action('AHEE__EE_System__load_controllers__load_front_controllers');
-        $this->loader->getShared('EE_Front_Controller');
-        return true;
-    }
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	protected function requestHandler()
+	{
+		do_action('AHEE__EE_System__load_controllers__load_front_controllers');
+		$this->loader->getShared('EE_Front_Controller');
+		return true;
+	}
 }

core/domain/entities/routing/handlers/frontend/ShortcodeRequests.php

Indentation +64 added lines, -64 removed lines

@@ -17,72 +17,72 @@
 class ShortcodeRequests extends Route
 {
 
-    /**
-     * returns true if the current request matches this route
-     * child classes can override and use Request directly to match route with request
-     * or supply a RouteMatchSpecification class and just use the below
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    public function matchesCurrentRequest()
-    {
-        return $this->request->isFrontend() || $this->request->isIframe() || $this->request->isAjax();
-    }
+	/**
+	 * returns true if the current request matches this route
+	 * child classes can override and use Request directly to match route with request
+	 * or supply a RouteMatchSpecification class and just use the below
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	public function matchesCurrentRequest()
+	{
+		return $this->request->isFrontend() || $this->request->isIframe() || $this->request->isAjax();
+	}
 
 
-    /**
-     * @since $VID:$
-     */
-    protected function registerDependencies()
-    {
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled',
-            ['EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout',
-            ['EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees',
-            ['EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\shortcodes\EspressoEvents',
-            ['EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou',
-            ['EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector',
-            ['EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage',
-            ['EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache]
-        );
-    }
+	/**
+	 * @since $VID:$
+	 */
+	protected function registerDependencies()
+	{
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled',
+			['EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout',
+			['EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees',
+			['EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\shortcodes\EspressoEvents',
+			['EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou',
+			['EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector',
+			['EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage',
+			['EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache]
+		);
+	}
 
 
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    protected function requestHandler()
-    {
-        // load, register, and add shortcodes the new way
-        $this->loader->getShared(
-            'EventEspresso\core\services\shortcodes\ShortcodesManager',
-            [
-                // and the old way, but we'll put it under control of the new system
-                EE_Config::getLegacyShortcodesManager(),
-            ]
-        );
-        return true;
-    }
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	protected function requestHandler()
+	{
+		// load, register, and add shortcodes the new way
+		$this->loader->getShared(
+			'EventEspresso\core\services\shortcodes\ShortcodesManager',
+			[
+				// and the old way, but we'll put it under control of the new system
+				EE_Config::getLegacyShortcodesManager(),
+			]
+		);
+		return true;
+	}
 }