eventespresso / event-espresso-core

core/services/commands/registration/CreateRegistrationCommand.php

Indentation +147 added lines, -147 removed lines

@@ -24,151 +24,151 @@
  */
 class CreateRegistrationCommand extends Command implements CommandRequiresCapCheckInterface
 {
-    /**
-     * @var EE_Transaction $transaction
-     */
-    private $transaction;
-
-    /**
-     * @var EE_Ticket $ticket
-     */
-    private $ticket;
-
-    /**
-     * @var EE_Line_Item $ticket_line_item
-     */
-    private $ticket_line_item;
-
-    /**
-     * @var int $reg_count
-     */
-    private $reg_count;
-
-    /**
-     * @var int $reg_group_size
-     */
-    private $reg_group_size;
-
-    /**
-     * @var string $reg_status
-     */
-    private $reg_status;
-
-    /**
-     * @var EE_Registration $registration
-     */
-    protected $registration;
-
-
-    /**
-     * CreateRegistrationCommand constructor.
-     *
-     * @param EE_Transaction $transaction
-     * @param EE_Line_Item   $ticket_line_item
-     * @param int            $reg_count
-     * @param int            $reg_group_size
-     * @param string         $reg_status
-     * @throws InvalidEntityException
-     */
-    public function __construct(
-        EE_Transaction $transaction,
-        EE_Line_Item $ticket_line_item,
-        $reg_count = 1,
-        $reg_group_size = 0,
-        $reg_status = EEM_Registration::status_id_incomplete
-    ) {
-        // grab the related ticket object for this line_item
-        $this->ticket = $ticket_line_item->ticket();
-        if (! $this->ticket instanceof EE_Ticket) {
-            throw new InvalidEntityException(
-                is_object($this->ticket) ? get_class($this->ticket) : gettype($this->ticket),
-                'EE_Ticket',
-                sprintf(
-                    esc_html__('Line item %s did not contain a valid ticket', 'event_espresso'),
-                    $ticket_line_item->ID()
-                )
-            );
-        }
-        $this->transaction = $transaction;
-        $this->ticket_line_item = $ticket_line_item;
-        $this->reg_count = absint($reg_count);
-        $this->reg_group_size = absint($reg_group_size);
-        $this->reg_status = $reg_status;
-    }
-
-
-    /**
-     * @return CapCheckInterface
-     * @throws InvalidDataTypeException
-     */
-    public function getCapCheck()
-    {
-        if (! $this->cap_check instanceof CapCheckInterface) {
-            return new CapCheck('ee_edit_registrations', 'create_new_registration');
-        }
-        return $this->cap_check;
-    }
-
-
-    /**
-     * @return EE_Transaction
-     */
-    public function transaction()
-    {
-        return $this->transaction;
-    }
-
-
-    /**
-     * @return EE_Ticket
-     */
-    public function ticket()
-    {
-        return $this->ticket;
-    }
-
-
-    /**
-     * @return EE_Line_Item
-     */
-    public function ticketLineItem()
-    {
-        return $this->ticket_line_item;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function regCount()
-    {
-        return $this->reg_count;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function regGroupSize()
-    {
-        return $this->reg_group_size;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function regStatus()
-    {
-        return $this->reg_status;
-    }
-
-
-    /**
-     * @return EE_Registration
-     */
-    public function registration()
-    {
-        return $this->registration;
-    }
+	/**
+	 * @var EE_Transaction $transaction
+	 */
+	private $transaction;
+
+	/**
+	 * @var EE_Ticket $ticket
+	 */
+	private $ticket;
+
+	/**
+	 * @var EE_Line_Item $ticket_line_item
+	 */
+	private $ticket_line_item;
+
+	/**
+	 * @var int $reg_count
+	 */
+	private $reg_count;
+
+	/**
+	 * @var int $reg_group_size
+	 */
+	private $reg_group_size;
+
+	/**
+	 * @var string $reg_status
+	 */
+	private $reg_status;
+
+	/**
+	 * @var EE_Registration $registration
+	 */
+	protected $registration;
+
+
+	/**
+	 * CreateRegistrationCommand constructor.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param EE_Line_Item   $ticket_line_item
+	 * @param int            $reg_count
+	 * @param int            $reg_group_size
+	 * @param string         $reg_status
+	 * @throws InvalidEntityException
+	 */
+	public function __construct(
+		EE_Transaction $transaction,
+		EE_Line_Item $ticket_line_item,
+		$reg_count = 1,
+		$reg_group_size = 0,
+		$reg_status = EEM_Registration::status_id_incomplete
+	) {
+		// grab the related ticket object for this line_item
+		$this->ticket = $ticket_line_item->ticket();
+		if (! $this->ticket instanceof EE_Ticket) {
+			throw new InvalidEntityException(
+				is_object($this->ticket) ? get_class($this->ticket) : gettype($this->ticket),
+				'EE_Ticket',
+				sprintf(
+					esc_html__('Line item %s did not contain a valid ticket', 'event_espresso'),
+					$ticket_line_item->ID()
+				)
+			);
+		}
+		$this->transaction = $transaction;
+		$this->ticket_line_item = $ticket_line_item;
+		$this->reg_count = absint($reg_count);
+		$this->reg_group_size = absint($reg_group_size);
+		$this->reg_status = $reg_status;
+	}
+
+
+	/**
+	 * @return CapCheckInterface
+	 * @throws InvalidDataTypeException
+	 */
+	public function getCapCheck()
+	{
+		if (! $this->cap_check instanceof CapCheckInterface) {
+			return new CapCheck('ee_edit_registrations', 'create_new_registration');
+		}
+		return $this->cap_check;
+	}
+
+
+	/**
+	 * @return EE_Transaction
+	 */
+	public function transaction()
+	{
+		return $this->transaction;
+	}
+
+
+	/**
+	 * @return EE_Ticket
+	 */
+	public function ticket()
+	{
+		return $this->ticket;
+	}
+
+
+	/**
+	 * @return EE_Line_Item
+	 */
+	public function ticketLineItem()
+	{
+		return $this->ticket_line_item;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function regCount()
+	{
+		return $this->reg_count;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function regGroupSize()
+	{
+		return $this->reg_group_size;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function regStatus()
+	{
+		return $this->reg_status;
+	}
+
+
+	/**
+	 * @return EE_Registration
+	 */
+	public function registration()
+	{
+		return $this->registration;
+	}
 }

core/services/commands/CommandRequiresCapCheckInterface.php

Indentation +4 added lines, -4 removed lines

@@ -13,8 +13,8 @@
  */
 interface CommandRequiresCapCheckInterface
 {
-    /**
-     * @return CapCheckInterface
-     */
-    public function getCapCheck();
+	/**
+	 * @return CapCheckInterface
+	 */
+	public function getCapCheck();
 }

core/services/routing/RouteHandler.php

Indentation +175 added lines, -175 removed lines

@@ -21,182 +21,182 @@
  */
 class RouteHandler
 {
-    /**
-     * @var CapabilitiesCheckerInterface $capabilities_checker
-     */
-    private $capabilities_checker;
-
-    /**
-     * @var JsonDataNodeHandler $data_node_handler
-     */
-    private $data_node_handler;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-    /**
-     * @var RouteCollection $routes
-     */
-    private $routes;
-
-    /**
-     * @var boolean $print_data_nodes
-     */
-    private $print_data_nodes = true;
-
-    /**
-     * @var string $route_request_type
-     */
-    protected $route_request_type = '';
-
-
-    /**
-     * RouteHandler constructor.
-     *
-     * @param CapabilitiesCheckerInterface $capabilities_checker
-     * @param JsonDataNodeHandler $data_node_handler
-     * @param LoaderInterface     $loader
-     * @param RequestInterface    $request
-     * @param RouteCollection     $routes
-     */
-    public function __construct(
-        CapabilitiesCheckerInterface $capabilities_checker,
-        JsonDataNodeHandler $data_node_handler,
-        LoaderInterface $loader,
-        RequestInterface $request,
-        RouteCollection $routes
-    ) {
-        $this->capabilities_checker = $capabilities_checker;
-        $this->data_node_handler = $data_node_handler;
-        $this->loader            = $loader;
-        $this->request           = $request;
-        $this->routes            = $routes;
-    }
-
-
-    /**
-     * @param string $fqcn   Fully Qualified Class Name for Route
-     * @param bool   $handle if true [default] will immediately call RouteInterface::handleRequest() after adding
-     * @throws Exception
-     */
-    public function addRoute(string $fqcn, bool $handle = true)
-    {
-        try {
-            $route = $this->loader->getShared($fqcn);
-            $this->validateRoute($route, $fqcn);
-            if ($this->capabilities_checker->processCapCheck($route->getCapCheck(), true)) {
-                $this->routes->add($route);
-                $this->handle($route, $handle);
-            }
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay(
-                new DomainException(
-                    sprintf(
-                        esc_html__(
-                            'The following error occurred while trying to handle the "%1$s" route:%2$s%3$s',
-                            'event_espresso'
-                        ),
-                        $fqcn,
-                        '<br />',
-                        $exception->getMessage()
-                    )
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getRouteRequestType(): string
-    {
-        return $this->route_request_type;
-    }
-
-
-    /**
-     * @param string $route_request_type
-     */
-    public function setRouteRequestType(string $route_request_type = '')
-    {
-        $this->route_request_type = ! empty($route_request_type) ? $route_request_type : $this->route_request_type;
-    }
-
-
-    /**
-     * @param RouteInterface $route
-     * @param bool           $handle if true [default] will immediately call RouteInterface::handleRequest()
-     */
-    public function handle(RouteInterface $route, bool $handle = true)
-    {
-        if ($handle && $route->isNotHandled()) {
-            $route->handleRequest();
-            if ($route instanceof PrimaryRoute) {
-                $this->setRouteRequestType($route->getRouteRequestType());
-            }
-            $data_node = $route->dataNode();
-            if ($data_node instanceof JsonDataNode) {
-                $this->data_node_handler->addDataNode($data_node);
-                $this->printDataNodes();
-            }
-        }
-    }
-
-
-    /**
-     * calls RouteInterface::handleRequest() on all Routes that
-     *      - match current request
-     *      - have yet to be handled
-     *
-     * @return void
-     */
-    public function handleRoutesForCurrentRequest()
-    {
-        $this->routes->handleRoutesForCurrentRequest();
-    }
-
-
-    /**
-     * @return void
-     */
-    private function printDataNodes()
-    {
-        if ($this->print_data_nodes) {
-            add_action('admin_footer', [$this->data_node_handler, 'printDataNode'], 0);
-            add_action('wp_footer', [$this->data_node_handler, 'printDataNode'], 0);
-            $this->print_data_nodes = false;
-        }
-    }
-
-
-    /**
-     * @param RouteInterface|null $route
-     * @param string              $fqcn
-     */
-    private function validateRoute(?RouteInterface $route, string $fqcn = '')
-    {
-        if (! $route instanceof RouteInterface) {
-            throw new InvalidClassException(
-                sprintf(
-                    /*
+	/**
+	 * @var CapabilitiesCheckerInterface $capabilities_checker
+	 */
+	private $capabilities_checker;
+
+	/**
+	 * @var JsonDataNodeHandler $data_node_handler
+	 */
+	private $data_node_handler;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+	/**
+	 * @var RouteCollection $routes
+	 */
+	private $routes;
+
+	/**
+	 * @var boolean $print_data_nodes
+	 */
+	private $print_data_nodes = true;
+
+	/**
+	 * @var string $route_request_type
+	 */
+	protected $route_request_type = '';
+
+
+	/**
+	 * RouteHandler constructor.
+	 *
+	 * @param CapabilitiesCheckerInterface $capabilities_checker
+	 * @param JsonDataNodeHandler $data_node_handler
+	 * @param LoaderInterface     $loader
+	 * @param RequestInterface    $request
+	 * @param RouteCollection     $routes
+	 */
+	public function __construct(
+		CapabilitiesCheckerInterface $capabilities_checker,
+		JsonDataNodeHandler $data_node_handler,
+		LoaderInterface $loader,
+		RequestInterface $request,
+		RouteCollection $routes
+	) {
+		$this->capabilities_checker = $capabilities_checker;
+		$this->data_node_handler = $data_node_handler;
+		$this->loader            = $loader;
+		$this->request           = $request;
+		$this->routes            = $routes;
+	}
+
+
+	/**
+	 * @param string $fqcn   Fully Qualified Class Name for Route
+	 * @param bool   $handle if true [default] will immediately call RouteInterface::handleRequest() after adding
+	 * @throws Exception
+	 */
+	public function addRoute(string $fqcn, bool $handle = true)
+	{
+		try {
+			$route = $this->loader->getShared($fqcn);
+			$this->validateRoute($route, $fqcn);
+			if ($this->capabilities_checker->processCapCheck($route->getCapCheck(), true)) {
+				$this->routes->add($route);
+				$this->handle($route, $handle);
+			}
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay(
+				new DomainException(
+					sprintf(
+						esc_html__(
+							'The following error occurred while trying to handle the "%1$s" route:%2$s%3$s',
+							'event_espresso'
+						),
+						$fqcn,
+						'<br />',
+						$exception->getMessage()
+					)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getRouteRequestType(): string
+	{
+		return $this->route_request_type;
+	}
+
+
+	/**
+	 * @param string $route_request_type
+	 */
+	public function setRouteRequestType(string $route_request_type = '')
+	{
+		$this->route_request_type = ! empty($route_request_type) ? $route_request_type : $this->route_request_type;
+	}
+
+
+	/**
+	 * @param RouteInterface $route
+	 * @param bool           $handle if true [default] will immediately call RouteInterface::handleRequest()
+	 */
+	public function handle(RouteInterface $route, bool $handle = true)
+	{
+		if ($handle && $route->isNotHandled()) {
+			$route->handleRequest();
+			if ($route instanceof PrimaryRoute) {
+				$this->setRouteRequestType($route->getRouteRequestType());
+			}
+			$data_node = $route->dataNode();
+			if ($data_node instanceof JsonDataNode) {
+				$this->data_node_handler->addDataNode($data_node);
+				$this->printDataNodes();
+			}
+		}
+	}
+
+
+	/**
+	 * calls RouteInterface::handleRequest() on all Routes that
+	 *      - match current request
+	 *      - have yet to be handled
+	 *
+	 * @return void
+	 */
+	public function handleRoutesForCurrentRequest()
+	{
+		$this->routes->handleRoutesForCurrentRequest();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function printDataNodes()
+	{
+		if ($this->print_data_nodes) {
+			add_action('admin_footer', [$this->data_node_handler, 'printDataNode'], 0);
+			add_action('wp_footer', [$this->data_node_handler, 'printDataNode'], 0);
+			$this->print_data_nodes = false;
+		}
+	}
+
+
+	/**
+	 * @param RouteInterface|null $route
+	 * @param string              $fqcn
+	 */
+	private function validateRoute(?RouteInterface $route, string $fqcn = '')
+	{
+		if (! $route instanceof RouteInterface) {
+			throw new InvalidClassException(
+				sprintf(
+					/*
                      * translators:
                      * The supplied FQCN (Fully\Qualified\Class\Name) must be an instance of RouteInterface.
                      */
-                    esc_html__(
-                        'The supplied FQCN (%1$s) must be an instance of RouteInterface.',
-                        'event_espresso'
-                    ),
-                    $fqcn
-                )
-            );
-        }
-    }
+					esc_html__(
+						'The supplied FQCN (%1$s) must be an instance of RouteInterface.',
+						'event_espresso'
+					),
+					$fqcn
+				)
+			);
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -183,7 +183,7 @@
      */
     private function validateRoute(?RouteInterface $route, string $fqcn = '')
     {
-        if (! $route instanceof RouteInterface) {
+        if ( ! $route instanceof RouteInterface) {
             throw new InvalidClassException(
                 sprintf(
                     /*

core/services/routing/Route.php

Indentation +267 added lines, -267 removed lines

@@ -28,271 +28,271 @@
  */
 abstract class Route implements RouteInterface, RequiresCapCheckInterface
 {
-    /**
-     * @var AssetManagerInterface $asset_manager
-     */
-    protected $asset_manager;
-
-    /**
-     * @var EE_Dependency_Map $dependency_map
-     */
-    protected $dependency_map;
-
-    /**
-     * @var JsonDataNode $data_node
-     */
-    protected $data_node;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-    /**
-     * @var RouteMatchSpecificationInterface $specification
-     */
-    protected $specification;
-
-    /**
-     * @var boolean $handled
-     */
-    private $handled = false;
-
-    /**
-     * @var array $default_dependencies
-     */
-    protected static $default_dependencies = [
-        'EE_Dependency_Map'                           => EE_Dependency_Map::load_from_cache,
-        'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
-        'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-    ];
-
-    /**
-     * @var array $full_dependencies
-     */
-    protected static $full_dependencies = [
-        'EE_Dependency_Map'                             => EE_Dependency_Map::load_from_cache,
-        'EventEspresso\core\services\loaders\Loader'    => EE_Dependency_Map::load_from_cache,
-        'EventEspresso\core\services\request\Request'   => EE_Dependency_Map::load_from_cache,
-        'EventEspresso\core\services\json\JsonDataNode' => EE_Dependency_Map::load_from_cache,
-        RouteMatchSpecificationInterface::class         => EE_Dependency_Map::load_from_cache,
-    ];
-
-
-    /**
-     * Route constructor.
-     *
-     * @param EE_Dependency_Map                     $dependency_map
-     * @param LoaderInterface                       $loader
-     * @param RequestInterface                      $request
-     * @param JsonDataNode|null                     $data_node
-     * @param RouteMatchSpecificationInterface|null $specification
-     */
-    public function __construct(
-        EE_Dependency_Map $dependency_map,
-        LoaderInterface $loader,
-        RequestInterface $request,
-        JsonDataNode $data_node = null,
-        RouteMatchSpecificationInterface $specification = null
-    ) {
-        $this->dependency_map = $dependency_map;
-        $this->data_node      = $data_node;
-        $this->loader         = $loader;
-        $this->request        = $request;
-        $this->setSpecification($specification);
-    }
-
-
-    /**
-     * @return void
-     */
-    abstract protected function registerDependencies();
-
-
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     */
-    abstract protected function requestHandler(): bool;
-
-
-    /**
-     * called just before matchesCurrentRequest()
-     * and allows Route to perform any setup required such as calling setSpecification()
-     *
-     * @return void
-     */
-    public function initialize()
-    {
-        // do nothing by default
-    }
-
-
-    /**
-     * 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
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        return $this->specification instanceof RouteMatchSpecificationInterface
-               && $this->specification->isMatchingRoute();
-    }
-
-
-    /**
-     * returns the FQCN for this route's JsonDataNode
-     *
-     * @return string
-     */
-    protected function dataNodeClass(): string
-    {
-        return '';
-    }
-
-
-    public function getCapCheck()
-    {
-        return new PublicCapabilities('', 'access Event Espresso route');
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function getDefaultDependencies(): array
-    {
-        return self::$default_dependencies;
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function getFullDependencies(): array
-    {
-        return self::$full_dependencies;
-    }
-
-
-    /**
-     * @param JsonDataNode|null $data_node
-     */
-    protected function setDataNode(JsonDataNode $data_node = null)
-    {
-        $this->data_node = $data_node;
-    }
-
-
-    /**
-     * @param RouteMatchSpecificationInterface|null $specification
-     */
-    protected function setSpecification(RouteMatchSpecificationInterface $specification = null)
-    {
-        $this->specification = $specification;
-    }
-
-
-    /**
-     * @return JsonDataNode
-     */
-    public function dataNode(): ?JsonDataNode
-    {
-        return $this->data_node;
-    }
-
-
-    /**
-     * 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
-     */
-    public function handleRequest(): bool
-    {
-        if ($this->isNotHandled()) {
-            $this->initialize();
-            if ($this->matchesCurrentRequest()) {
-                do_action('AHEE__EventEspresso_core_domain_entities_routes_handlers_Route__handleRequest', $this);
-                $this->registerDependencies();
-                $this->loadDataNode();
-                $this->verifyIsHandled($this->requestHandler());
-            }
-        }
-        return $this->handled;
-    }
-
-
-    /**
-     * @return bool
-     */
-    final public function isHandled(): bool
-    {
-        return $this->handled;
-    }
-
-
-    /**
-     * @return bool
-     */
-    final public function isNotHandled(): bool
-    {
-        return ! $this->handled;
-    }
-
-
-    /**
-     * @return void
-     */
-    private function loadDataNode()
-    {
-        $data_node_fqcn = $this->dataNodeClass();
-        if (! empty($data_node_fqcn)) {
-            $data_node = $this->loader->getShared($data_node_fqcn);
-            $this->setDataNode($data_node);
-        }
-    }
-
-
-    /**
-     * @param string $domain_fqcn
-     */
-    public function initializeBaristaForDomain(string $domain_fqcn)
-    {
-        if (apply_filters('FHEE__load_Barista', true)) {
-            /** @var BaristaFactory $factory */
-            $factory = $this->loader->getShared(BaristaFactory::class);
-            $barista = $factory->createFromDomainClass($domain_fqcn);
-            if ($barista instanceof BaristaInterface) {
-                $barista->initialize();
-            }
-        }
-    }
-
-
-    /**
-     * @var bool
-     */
-    private function verifyIsHandled($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.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->handled = filter_var($handled, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * @var AssetManagerInterface $asset_manager
+	 */
+	protected $asset_manager;
+
+	/**
+	 * @var EE_Dependency_Map $dependency_map
+	 */
+	protected $dependency_map;
+
+	/**
+	 * @var JsonDataNode $data_node
+	 */
+	protected $data_node;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+	/**
+	 * @var RouteMatchSpecificationInterface $specification
+	 */
+	protected $specification;
+
+	/**
+	 * @var boolean $handled
+	 */
+	private $handled = false;
+
+	/**
+	 * @var array $default_dependencies
+	 */
+	protected static $default_dependencies = [
+		'EE_Dependency_Map'                           => EE_Dependency_Map::load_from_cache,
+		'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
+		'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+	];
+
+	/**
+	 * @var array $full_dependencies
+	 */
+	protected static $full_dependencies = [
+		'EE_Dependency_Map'                             => EE_Dependency_Map::load_from_cache,
+		'EventEspresso\core\services\loaders\Loader'    => EE_Dependency_Map::load_from_cache,
+		'EventEspresso\core\services\request\Request'   => EE_Dependency_Map::load_from_cache,
+		'EventEspresso\core\services\json\JsonDataNode' => EE_Dependency_Map::load_from_cache,
+		RouteMatchSpecificationInterface::class         => EE_Dependency_Map::load_from_cache,
+	];
+
+
+	/**
+	 * Route constructor.
+	 *
+	 * @param EE_Dependency_Map                     $dependency_map
+	 * @param LoaderInterface                       $loader
+	 * @param RequestInterface                      $request
+	 * @param JsonDataNode|null                     $data_node
+	 * @param RouteMatchSpecificationInterface|null $specification
+	 */
+	public function __construct(
+		EE_Dependency_Map $dependency_map,
+		LoaderInterface $loader,
+		RequestInterface $request,
+		JsonDataNode $data_node = null,
+		RouteMatchSpecificationInterface $specification = null
+	) {
+		$this->dependency_map = $dependency_map;
+		$this->data_node      = $data_node;
+		$this->loader         = $loader;
+		$this->request        = $request;
+		$this->setSpecification($specification);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	abstract protected function registerDependencies();
+
+
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 */
+	abstract protected function requestHandler(): bool;
+
+
+	/**
+	 * called just before matchesCurrentRequest()
+	 * and allows Route to perform any setup required such as calling setSpecification()
+	 *
+	 * @return void
+	 */
+	public function initialize()
+	{
+		// do nothing by default
+	}
+
+
+	/**
+	 * 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
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		return $this->specification instanceof RouteMatchSpecificationInterface
+			   && $this->specification->isMatchingRoute();
+	}
+
+
+	/**
+	 * returns the FQCN for this route's JsonDataNode
+	 *
+	 * @return string
+	 */
+	protected function dataNodeClass(): string
+	{
+		return '';
+	}
+
+
+	public function getCapCheck()
+	{
+		return new PublicCapabilities('', 'access Event Espresso route');
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function getDefaultDependencies(): array
+	{
+		return self::$default_dependencies;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function getFullDependencies(): array
+	{
+		return self::$full_dependencies;
+	}
+
+
+	/**
+	 * @param JsonDataNode|null $data_node
+	 */
+	protected function setDataNode(JsonDataNode $data_node = null)
+	{
+		$this->data_node = $data_node;
+	}
+
+
+	/**
+	 * @param RouteMatchSpecificationInterface|null $specification
+	 */
+	protected function setSpecification(RouteMatchSpecificationInterface $specification = null)
+	{
+		$this->specification = $specification;
+	}
+
+
+	/**
+	 * @return JsonDataNode
+	 */
+	public function dataNode(): ?JsonDataNode
+	{
+		return $this->data_node;
+	}
+
+
+	/**
+	 * 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
+	 */
+	public function handleRequest(): bool
+	{
+		if ($this->isNotHandled()) {
+			$this->initialize();
+			if ($this->matchesCurrentRequest()) {
+				do_action('AHEE__EventEspresso_core_domain_entities_routes_handlers_Route__handleRequest', $this);
+				$this->registerDependencies();
+				$this->loadDataNode();
+				$this->verifyIsHandled($this->requestHandler());
+			}
+		}
+		return $this->handled;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	final public function isHandled(): bool
+	{
+		return $this->handled;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	final public function isNotHandled(): bool
+	{
+		return ! $this->handled;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function loadDataNode()
+	{
+		$data_node_fqcn = $this->dataNodeClass();
+		if (! empty($data_node_fqcn)) {
+			$data_node = $this->loader->getShared($data_node_fqcn);
+			$this->setDataNode($data_node);
+		}
+	}
+
+
+	/**
+	 * @param string $domain_fqcn
+	 */
+	public function initializeBaristaForDomain(string $domain_fqcn)
+	{
+		if (apply_filters('FHEE__load_Barista', true)) {
+			/** @var BaristaFactory $factory */
+			$factory = $this->loader->getShared(BaristaFactory::class);
+			$barista = $factory->createFromDomainClass($domain_fqcn);
+			if ($barista instanceof BaristaInterface) {
+				$barista->initialize();
+			}
+		}
+	}
+
+
+	/**
+	 * @var bool
+	 */
+	private function verifyIsHandled($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.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->handled = filter_var($handled, FILTER_VALIDATE_BOOLEAN);
+	}
 }

core/domain/services/capabilities/CapCheck.php

Indentation +49 added lines, -49 removed lines

@@ -14,63 +14,63 @@
  */
 class CapCheck implements CapCheckInterface
 {
-    /**
-     * @var string|array $capability
-     */
-    private $capability;
+	/**
+	 * @var string|array $capability
+	 */
+	private $capability;
 
-    /**
-     * @var string $context
-     */
-    private $context;
+	/**
+	 * @var string $context
+	 */
+	private $context;
 
-    /**
-     * @var int|string $ID
-     */
-    private $ID;
+	/**
+	 * @var int|string $ID
+	 */
+	private $ID;
 
 
-    /**
-     * @param string|array $capability   - the capability to be checked, like: 'ee_edit_registrations',
-     *                                     or an array of capability strings
-     * @param string       $context      - what the user is attempting to do, like: 'Edit Registration'
-     * @param int|string   $ID           - (optional) ID for item where current_user_can is being called from
-     * @throws InvalidDataTypeException
-     */
-    public function __construct($capability, string $context, $ID = 0)
-    {
-        if (! (is_string($capability) || is_array($capability))) {
-            throw new InvalidDataTypeException('$capability', $capability, 'string or array');
-        }
-        $this->capability = $capability;
-        $this->context = strtolower(str_replace(' ', '_', $context));
-        $this->ID = $ID;
-    }
+	/**
+	 * @param string|array $capability   - the capability to be checked, like: 'ee_edit_registrations',
+	 *                                     or an array of capability strings
+	 * @param string       $context      - what the user is attempting to do, like: 'Edit Registration'
+	 * @param int|string   $ID           - (optional) ID for item where current_user_can is being called from
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct($capability, string $context, $ID = 0)
+	{
+		if (! (is_string($capability) || is_array($capability))) {
+			throw new InvalidDataTypeException('$capability', $capability, 'string or array');
+		}
+		$this->capability = $capability;
+		$this->context = strtolower(str_replace(' ', '_', $context));
+		$this->ID = $ID;
+	}
 
 
-    /**
-     * @return string|array
-     */
-    public function capability()
-    {
-        return $this->capability;
-    }
+	/**
+	 * @return string|array
+	 */
+	public function capability()
+	{
+		return $this->capability;
+	}
 
 
-    /**
-     * @return string
-     */
-    public function context(): string
-    {
-        return $this->context;
-    }
+	/**
+	 * @return string
+	 */
+	public function context(): string
+	{
+		return $this->context;
+	}
 
 
-    /**
-     * @return int|string
-     */
-    public function ID()
-    {
-        return $this->ID;
-    }
+	/**
+	 * @return int|string
+	 */
+	public function ID()
+	{
+		return $this->ID;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -39,7 +39,7 @@
      */
     public function __construct($capability, string $context, $ID = 0)
     {
-        if (! (is_string($capability) || is_array($capability))) {
+        if ( ! (is_string($capability) || is_array($capability))) {
             throw new InvalidDataTypeException('$capability', $capability, 'string or array');
         }
         $this->capability = $capability;

core/domain/services/capabilities/CapabilitiesChecker.php

Indentation +82 added lines, -82 removed lines

@@ -17,94 +17,94 @@
  */
 class CapabilitiesChecker implements CapabilitiesCheckerInterface
 {
-    /**
-     * @type EE_Capabilities $capabilities
-     */
-    private $capabilities;
+	/**
+	 * @type EE_Capabilities $capabilities
+	 */
+	private $capabilities;
 
 
-    /**
-     * CapabilitiesChecker constructor
-     *
-     * @param EE_Capabilities $capabilities
-     */
-    public function __construct(EE_Capabilities $capabilities)
-    {
-        $this->capabilities = $capabilities;
-    }
+	/**
+	 * CapabilitiesChecker constructor
+	 *
+	 * @param EE_Capabilities $capabilities
+	 */
+	public function __construct(EE_Capabilities $capabilities)
+	{
+		$this->capabilities = $capabilities;
+	}
 
 
-    /**
-     * @return EE_Capabilities
-     */
-    protected function capabilities(): EE_Capabilities
-    {
-        return $this->capabilities;
-    }
+	/**
+	 * @return EE_Capabilities
+	 */
+	protected function capabilities(): EE_Capabilities
+	{
+		return $this->capabilities;
+	}
 
 
-    /**
-     * Verifies that the current user has ALL of the capabilities listed in the CapCheck DTO.
-     * If any of the individual capability checks fails, then the command will NOT be executed.
-     *
-     * @param CapCheckInterface|CapCheckInterface[] $cap_check
-     * @param bool                                  $suppress_exceptions
-     * @return bool
-     * @throws InvalidClassException
-     * @throws InsufficientPermissionsException
-     */
-    public function processCapCheck($cap_check, bool $suppress_exceptions = false): bool
-    {
-        if (is_array($cap_check)) {
-            $passed = true;
-            foreach ($cap_check as $check) {
-                $passed = $this->processCapCheck($check) ? $passed : false;
-            }
-            return $passed;
-        }
-        // at this point, $cap_check should be an individual instance of CapCheck
-        if (! $cap_check instanceof CapCheckInterface) {
-            if ($suppress_exceptions) {
-                return false;
-            }
-            throw new InvalidClassException(
-                '\EventEspresso\core\domain\services\capabilities\CapCheckInterface'
-            );
-        }
-        // sometimes cap checks are conditional, and no capabilities are required
-        if ($cap_check instanceof PublicCapabilities) {
-            return true;
-        }
-        $capabilities = (array) $cap_check->capability();
-        foreach ($capabilities as $capability) {
-            if (
-                ! $this->capabilities()->current_user_can(
-                    $capability,
-                    $cap_check->context(),
-                    $cap_check->ID()
-                )
-            ) {
-                if ($suppress_exceptions) {
-                    return false;
-                }
-                throw new InsufficientPermissionsException($cap_check->context());
-            }
-        }
-        return true;
-    }
+	/**
+	 * Verifies that the current user has ALL of the capabilities listed in the CapCheck DTO.
+	 * If any of the individual capability checks fails, then the command will NOT be executed.
+	 *
+	 * @param CapCheckInterface|CapCheckInterface[] $cap_check
+	 * @param bool                                  $suppress_exceptions
+	 * @return bool
+	 * @throws InvalidClassException
+	 * @throws InsufficientPermissionsException
+	 */
+	public function processCapCheck($cap_check, bool $suppress_exceptions = false): bool
+	{
+		if (is_array($cap_check)) {
+			$passed = true;
+			foreach ($cap_check as $check) {
+				$passed = $this->processCapCheck($check) ? $passed : false;
+			}
+			return $passed;
+		}
+		// at this point, $cap_check should be an individual instance of CapCheck
+		if (! $cap_check instanceof CapCheckInterface) {
+			if ($suppress_exceptions) {
+				return false;
+			}
+			throw new InvalidClassException(
+				'\EventEspresso\core\domain\services\capabilities\CapCheckInterface'
+			);
+		}
+		// sometimes cap checks are conditional, and no capabilities are required
+		if ($cap_check instanceof PublicCapabilities) {
+			return true;
+		}
+		$capabilities = (array) $cap_check->capability();
+		foreach ($capabilities as $capability) {
+			if (
+				! $this->capabilities()->current_user_can(
+					$capability,
+					$cap_check->context(),
+					$cap_check->ID()
+				)
+			) {
+				if ($suppress_exceptions) {
+					return false;
+				}
+				throw new InsufficientPermissionsException($cap_check->context());
+			}
+		}
+		return true;
+	}
 
 
-    /**
-     * @param array|string $capability - the capability to be checked, like: 'ee_edit_registrations'
-     * @param string       $context    - what the user is attempting to do, like: 'Edit Registration'
-     * @param int|string   $ID         - (optional) ID for item where current_user_can is being called from
-     * @return bool
-     * @throws InvalidDataTypeException
-     * @throws InsufficientPermissionsException
-     * @throws InvalidClassException
-     */
-    public function process($capability, string $context, $ID = 0): bool
-    {
-        return $this->processCapCheck(new CapCheck($capability, $context, $ID));
-    }
+	/**
+	 * @param array|string $capability - the capability to be checked, like: 'ee_edit_registrations'
+	 * @param string       $context    - what the user is attempting to do, like: 'Edit Registration'
+	 * @param int|string   $ID         - (optional) ID for item where current_user_can is being called from
+	 * @return bool
+	 * @throws InvalidDataTypeException
+	 * @throws InsufficientPermissionsException
+	 * @throws InvalidClassException
+	 */
+	public function process($capability, string $context, $ID = 0): bool
+	{
+		return $this->processCapCheck(new CapCheck($capability, $context, $ID));
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -63,7 +63,7 @@
             return $passed;
         }
         // at this point, $cap_check should be an individual instance of CapCheck
-        if (! $cap_check instanceof CapCheckInterface) {
+        if ( ! $cap_check instanceof CapCheckInterface) {
             if ($suppress_exceptions) {
                 return false;
             }

core/domain/services/capabilities/CapabilitiesCheckerInterface.php

Indentation +20 added lines, -20 removed lines

@@ -15,26 +15,26 @@
  */
 interface CapabilitiesCheckerInterface
 {
-    /**
-     * Verifies that the current user has ALL of the capabilities listed in the CapCheck DTO.
-     * If any of the individual capability checks fails, then the command will NOT be executed.
-     *
-     * @param CapCheckInterface|CapCheckInterface[] $cap_check
-     * @param bool                                  $suppress_exceptions
-     * @return bool
-     * @throws InvalidClassException
-     * @throws InsufficientPermissionsException
-     */
-    public function processCapCheck($cap_check, bool $suppress_exceptions = false): bool;
+	/**
+	 * Verifies that the current user has ALL of the capabilities listed in the CapCheck DTO.
+	 * If any of the individual capability checks fails, then the command will NOT be executed.
+	 *
+	 * @param CapCheckInterface|CapCheckInterface[] $cap_check
+	 * @param bool                                  $suppress_exceptions
+	 * @return bool
+	 * @throws InvalidClassException
+	 * @throws InsufficientPermissionsException
+	 */
+	public function processCapCheck($cap_check, bool $suppress_exceptions = false): bool;
 
 
-    /**
-     * @param array|string $capability - the capability to be checked, like: 'ee_edit_registrations'
-     * @param string $context    - what the user is attempting to do, like: 'Edit Registration'
-     * @param int|string    $ID         - (optional) ID for item where current_user_can is being called from
-     * @return bool
-     * @throws InsufficientPermissionsException
-     * @throws InvalidClassException
-     */
-    public function process($capability, string $context, $ID = 0): bool;
+	/**
+	 * @param array|string $capability - the capability to be checked, like: 'ee_edit_registrations'
+	 * @param string $context    - what the user is attempting to do, like: 'Edit Registration'
+	 * @param int|string    $ID         - (optional) ID for item where current_user_can is being called from
+	 * @return bool
+	 * @throws InsufficientPermissionsException
+	 * @throws InvalidClassException
+	 */
+	public function process($capability, string $context, $ID = 0): bool;
 }

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

Indentation +39 added lines, -39 removed lines

@@ -15,47 +15,47 @@
  */
 class ActivationRequests extends PrimaryRoute
 {
-    /**
-     * returns true if the current request matches this route
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        return $this->request->isActivation();
-    }
+	/**
+	 * returns true if the current request matches this route
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		return $this->request->isActivation();
+	}
 
 
-    /**
-     * @since $VID:$
-     */
-    protected function registerDependencies()
-    {
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\handlers\admin\AdminRoute',
-            AdminRoute::getDefaultDependencies()
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\handlers\admin\PueRequests',
-            Route::getDefaultDependencies()
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPluginsPage',
-            Route::getDefaultDependencies()
-        );
-    }
+	/**
+	 * @since $VID:$
+	 */
+	protected function registerDependencies()
+	{
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\handlers\admin\AdminRoute',
+			AdminRoute::getDefaultDependencies()
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\handlers\admin\PueRequests',
+			Route::getDefaultDependencies()
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\handlers\admin\WordPressPluginsPage',
+			Route::getDefaultDependencies()
+		);
+	}
 
 
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    protected function requestHandler(): bool
-    {
-        $this->setRouteRequestType(PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION);
-        return true;
-    }
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	protected function requestHandler(): bool
+	{
+		$this->setRouteRequestType(PrimaryRoute::ROUTE_REQUEST_TYPE_ACTIVATION);
+		return true;
+	}
 }

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

Indentation +84 added lines, -84 removed lines

@@ -26,88 +26,88 @@
  */
 class AdminRoute extends Route
 {
-    /**
-     * @var EE_Admin_Config $admin_config
-     */
-    protected $admin_config;
-
-    /**
-     * @var array $default_dependencies
-     */
-    protected static $default_dependencies = [
-        'EE_Admin_Config'                             => EE_Dependency_Map::load_from_cache,
-        'EE_Dependency_Map'                           => EE_Dependency_Map::load_from_cache,
-        'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
-        'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-    ];
-
-
-    /**
-     * Route constructor.
-     *
-     * @param EE_Admin_Config                       $admin_config
-     * @param EE_Dependency_Map                     $dependency_map
-     * @param LoaderInterface                       $loader
-     * @param RequestInterface                      $request
-     * @param JsonDataNode|null                     $data_node
-     * @param RouteMatchSpecificationInterface|null $specification
-     */
-    public function __construct(
-        EE_Admin_Config $admin_config,
-        EE_Dependency_Map $dependency_map,
-        LoaderInterface $loader,
-        RequestInterface $request,
-        JsonDataNode $data_node = null,
-        RouteMatchSpecificationInterface $specification = null
-    ) {
-        $this->admin_config = $admin_config;
-        parent::__construct($dependency_map, $loader, $request, $data_node, $specification);
-    }
-
-
-    public function getCapCheck()
-    {
-        return new CapCheck('edit_posts', 'access Event Espresso admin route');
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function getDefaultDependencies(): array
-    {
-        return self::$default_dependencies;
-    }
-
-
-    /**
-     * returns true if the current request matches this route
-     *
-     * @return bool
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        return $this->request->isAdmin() || $this->request->isAdminAjax() || $this->request->isActivation();
-    }
-
-
-    /**
-     * @return void
-     */
-    protected function registerDependencies()
-    {
-    }
-
-
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     */
-    protected function requestHandler(): bool
-    {
-        do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
-        $this->loader->getShared('EE_Admin');
-        return true;
-    }
+	/**
+	 * @var EE_Admin_Config $admin_config
+	 */
+	protected $admin_config;
+
+	/**
+	 * @var array $default_dependencies
+	 */
+	protected static $default_dependencies = [
+		'EE_Admin_Config'                             => EE_Dependency_Map::load_from_cache,
+		'EE_Dependency_Map'                           => EE_Dependency_Map::load_from_cache,
+		'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
+		'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+	];
+
+
+	/**
+	 * Route constructor.
+	 *
+	 * @param EE_Admin_Config                       $admin_config
+	 * @param EE_Dependency_Map                     $dependency_map
+	 * @param LoaderInterface                       $loader
+	 * @param RequestInterface                      $request
+	 * @param JsonDataNode|null                     $data_node
+	 * @param RouteMatchSpecificationInterface|null $specification
+	 */
+	public function __construct(
+		EE_Admin_Config $admin_config,
+		EE_Dependency_Map $dependency_map,
+		LoaderInterface $loader,
+		RequestInterface $request,
+		JsonDataNode $data_node = null,
+		RouteMatchSpecificationInterface $specification = null
+	) {
+		$this->admin_config = $admin_config;
+		parent::__construct($dependency_map, $loader, $request, $data_node, $specification);
+	}
+
+
+	public function getCapCheck()
+	{
+		return new CapCheck('edit_posts', 'access Event Espresso admin route');
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function getDefaultDependencies(): array
+	{
+		return self::$default_dependencies;
+	}
+
+
+	/**
+	 * returns true if the current request matches this route
+	 *
+	 * @return bool
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		return $this->request->isAdmin() || $this->request->isAdminAjax() || $this->request->isActivation();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	protected function registerDependencies()
+	{
+	}
+
+
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 */
+	protected function requestHandler(): bool
+	{
+		do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
+		$this->loader->getShared('EE_Admin');
+		return true;
+	}
 }