eventespresso / event-espresso-core

core/services/commands/middleware/CapChecker.php

Indentation +33 added lines, -33 removed lines

@@ -24,37 +24,37 @@
 class CapChecker implements CommandBusMiddlewareInterface
 {
 
-    /**
-     * @type CapabilitiesCheckerInterface $capabilities_checker
-     */
-    private $capabilities_checker;
-
-
-    /**
-     * CapChecker constructor
-     *
-     * @param CapabilitiesCheckerInterface $capabilities_checker
-     */
-    public function __construct(CapabilitiesCheckerInterface $capabilities_checker)
-    {
-        $this->capabilities_checker = $capabilities_checker;
-    }
-
-
-    /**
-     * @param CommandInterface $command
-     * @param Closure          $next
-     * @return mixed
-     * @throws InvalidClassException
-     * @throws InsufficientPermissionsException
-     */
-    public function handle(CommandInterface $command, Closure $next)
-    {
-        if ($command instanceof CommandRequiresCapCheckInterface) {
-            $this->capabilities_checker->processCapCheck(
-                $command->getCapCheck()
-            );
-        }
-        return $next($command);
-    }
+	/**
+	 * @type CapabilitiesCheckerInterface $capabilities_checker
+	 */
+	private $capabilities_checker;
+
+
+	/**
+	 * CapChecker constructor
+	 *
+	 * @param CapabilitiesCheckerInterface $capabilities_checker
+	 */
+	public function __construct(CapabilitiesCheckerInterface $capabilities_checker)
+	{
+		$this->capabilities_checker = $capabilities_checker;
+	}
+
+
+	/**
+	 * @param CommandInterface $command
+	 * @param Closure          $next
+	 * @return mixed
+	 * @throws InvalidClassException
+	 * @throws InsufficientPermissionsException
+	 */
+	public function handle(CommandInterface $command, Closure $next)
+	{
+		if ($command instanceof CommandRequiresCapCheckInterface) {
+			$this->capabilities_checker->processCapCheck(
+				$command->getCapCheck()
+			);
+		}
+		return $next($command);
+	}
 }

core/services/commands/CommandHandlerManager.php

Indentation +93 added lines, -93 removed lines

@@ -18,104 +18,104 @@
 class CommandHandlerManager implements CommandHandlerManagerInterface
 {
 
-    /**
-     * @var CommandHandlerInterface[] $command_handlers
-     */
-    protected $command_handlers;
+	/**
+	 * @var CommandHandlerInterface[] $command_handlers
+	 */
+	protected $command_handlers;
 
-    /**
-     * @type LoaderInterface $loader
-     */
-    private $loader;
+	/**
+	 * @type LoaderInterface $loader
+	 */
+	private $loader;
 
 
-    /**
-     * CommandHandlerManager constructor
-     *
-     * @param LoaderInterface $loader
-     */
-    public function __construct(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
+	/**
+	 * CommandHandlerManager constructor
+	 *
+	 * @param LoaderInterface $loader
+	 */
+	public function __construct(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
 
 
-    /**
-     * By default, Commands and CommandHandlers would normally
-     * reside in the same folder under the same namespace,
-     * and the names of the two classes would only differ in that
-     * one ends in "Command" and the other ends in "CommandHandler".
-     * However, if you wanted to utilize a CommandHandler from somewhere else,
-     * then this method allows you to add that CommandHandler and specify the FQCN
-     * (Fully Qualified ClassName) for the Command class that it should be used for.
-     * For example:
-     *      by default the "Vendor\some\namespace\DoSomethingCommand"
-     *      would resolve to using "Vendor\some\namespace\DoSomethingCommandHandler"
-     *      but if you wanted to instead process that commend using:
-     *      "Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler"
-     *      then the following code:
-     *      $CommandHandlerManager = $this->loader->getShared( 'CommandHandlerManagerInterface' );
-     *      $CommandHandlerManager->addCommandHandler(
-     *          new Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler(),
-     *          'Vendor\some\namespace\DoSomethingCommand'
-     *      );
-     *      would result in the alternate CommandHandler being used to process that Command
-     *
-     * @param CommandHandlerInterface $command_handler
-     * @param string                  $fqcn_for_command Fully Qualified ClassName for Command
-     * @return void
-     * @throws InvalidCommandHandlerException
-     */
-    public function addCommandHandler(CommandHandlerInterface $command_handler, $fqcn_for_command = '')
-    {
-        $command = ! empty($fqcn_for_command)
-            ? $fqcn_for_command
-            : str_replace('CommandHandler', 'Command', get_class($command_handler));
-        if (empty($command)) {
-            throw new InvalidCommandHandlerException($command);
-        }
-        $this->command_handlers[$command] = $command_handler;
-    }
+	/**
+	 * By default, Commands and CommandHandlers would normally
+	 * reside in the same folder under the same namespace,
+	 * and the names of the two classes would only differ in that
+	 * one ends in "Command" and the other ends in "CommandHandler".
+	 * However, if you wanted to utilize a CommandHandler from somewhere else,
+	 * then this method allows you to add that CommandHandler and specify the FQCN
+	 * (Fully Qualified ClassName) for the Command class that it should be used for.
+	 * For example:
+	 *      by default the "Vendor\some\namespace\DoSomethingCommand"
+	 *      would resolve to using "Vendor\some\namespace\DoSomethingCommandHandler"
+	 *      but if you wanted to instead process that commend using:
+	 *      "Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler"
+	 *      then the following code:
+	 *      $CommandHandlerManager = $this->loader->getShared( 'CommandHandlerManagerInterface' );
+	 *      $CommandHandlerManager->addCommandHandler(
+	 *          new Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler(),
+	 *          'Vendor\some\namespace\DoSomethingCommand'
+	 *      );
+	 *      would result in the alternate CommandHandler being used to process that Command
+	 *
+	 * @param CommandHandlerInterface $command_handler
+	 * @param string                  $fqcn_for_command Fully Qualified ClassName for Command
+	 * @return void
+	 * @throws InvalidCommandHandlerException
+	 */
+	public function addCommandHandler(CommandHandlerInterface $command_handler, $fqcn_for_command = '')
+	{
+		$command = ! empty($fqcn_for_command)
+			? $fqcn_for_command
+			: str_replace('CommandHandler', 'Command', get_class($command_handler));
+		if (empty($command)) {
+			throw new InvalidCommandHandlerException($command);
+		}
+		$this->command_handlers[$command] = $command_handler;
+	}
 
 
-    /**
-     * @param CommandInterface    $command
-     * @param CommandBusInterface $command_bus
-     * @return mixed
-     * @throws DomainException
-     * @throws CommandHandlerNotFoundException
-     */
-    public function getCommandHandler(CommandInterface $command, CommandBusInterface $command_bus = null)
-    {
-        $command_name = get_class($command);
-        $command_handler = apply_filters(
-            'FHEE__EventEspresso_core_services_commands_CommandHandlerManager__getCommandHandler__command_handler',
-            str_replace('Command', 'CommandHandler', $command_name),
-            $command
-        );
-        $handler = null;
-        // has a command handler already been set for this class ?
-        // if not, can we find one via the FQCN ?
-        if (isset($this->command_handlers[$command_name])) {
-            $handler = $this->command_handlers[$command_name];
-        } else if (class_exists($command_handler)) {
-            $handler = $this->loader->getShared($command_handler);
-        }
-        // if Handler requires an instance of the CommandBus, but that has not yet been set
-        if ($handler instanceof CompositeCommandHandler && ! $handler->commandBus() instanceof CommandBusInterface) {
-            if (! $command_bus instanceof CommandBusInterface) {
-                throw new DomainException(
-                    esc_html__(
-                        'CompositeCommandHandler classes require an instance of the CommandBus.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $handler->setCommandBus($command_bus);
-        }
-        if ($handler instanceof CommandHandlerInterface) {
-            return $handler;
-        }
-        throw new CommandHandlerNotFoundException($command_handler);
-    }
+	/**
+	 * @param CommandInterface    $command
+	 * @param CommandBusInterface $command_bus
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws CommandHandlerNotFoundException
+	 */
+	public function getCommandHandler(CommandInterface $command, CommandBusInterface $command_bus = null)
+	{
+		$command_name = get_class($command);
+		$command_handler = apply_filters(
+			'FHEE__EventEspresso_core_services_commands_CommandHandlerManager__getCommandHandler__command_handler',
+			str_replace('Command', 'CommandHandler', $command_name),
+			$command
+		);
+		$handler = null;
+		// has a command handler already been set for this class ?
+		// if not, can we find one via the FQCN ?
+		if (isset($this->command_handlers[$command_name])) {
+			$handler = $this->command_handlers[$command_name];
+		} else if (class_exists($command_handler)) {
+			$handler = $this->loader->getShared($command_handler);
+		}
+		// if Handler requires an instance of the CommandBus, but that has not yet been set
+		if ($handler instanceof CompositeCommandHandler && ! $handler->commandBus() instanceof CommandBusInterface) {
+			if (! $command_bus instanceof CommandBusInterface) {
+				throw new DomainException(
+					esc_html__(
+						'CompositeCommandHandler classes require an instance of the CommandBus.',
+						'event_espresso'
+					)
+				);
+			}
+			$handler->setCommandBus($command_bus);
+		}
+		if ($handler instanceof CommandHandlerInterface) {
+			return $handler;
+		}
+		throw new CommandHandlerNotFoundException($command_handler);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -103,7 +103,7 @@
         }
         // if Handler requires an instance of the CommandBus, but that has not yet been set
         if ($handler instanceof CompositeCommandHandler && ! $handler->commandBus() instanceof CommandBusInterface) {
-            if (! $command_bus instanceof CommandBusInterface) {
+            if ( ! $command_bus instanceof CommandBusInterface) {
                 throw new DomainException(
                     esc_html__(
                         'CompositeCommandHandler classes require an instance of the CommandBus.',

core/services/commands/ticket/CreateTicketLineItemCommandHandler.php

Indentation +37 added lines, -37 removed lines

@@ -19,41 +19,41 @@
 {
 
 
-    /**
-     * @var CreateTicketLineItemService $factory
-     */
-    private $factory;
-
-
-    /**
-     * Command constructor
-     *
-     * @param CreateTicketLineItemService $factory
-     */
-    public function __construct(CreateTicketLineItemService $factory)
-    {
-        $this->factory = $factory;
-    }
-
-
-    /**
-     * @param \EventEspresso\core\services\commands\CommandInterface $command
-     * @return \EE_Line_Item
-     * @throws \EventEspresso\core\exceptions\InvalidEntityException
-     * @throws \EventEspresso\core\exceptions\UnexpectedEntityException
-     * @throws \EE_Error
-     */
-    public function handle(CommandInterface $command)
-    {
-        /** @var CreateTicketLineItemCommand $command */
-        if (! $command instanceof CreateTicketLineItemCommand) {
-            throw new InvalidEntityException(get_class($command), 'CreateTicketLineItemCommand');
-        }
-        // create new line item for ticket
-        return $this->factory->create(
-            $command->transaction(),
-            $command->ticket(),
-            $command->quantity()
-        );
-    }
+	/**
+	 * @var CreateTicketLineItemService $factory
+	 */
+	private $factory;
+
+
+	/**
+	 * Command constructor
+	 *
+	 * @param CreateTicketLineItemService $factory
+	 */
+	public function __construct(CreateTicketLineItemService $factory)
+	{
+		$this->factory = $factory;
+	}
+
+
+	/**
+	 * @param \EventEspresso\core\services\commands\CommandInterface $command
+	 * @return \EE_Line_Item
+	 * @throws \EventEspresso\core\exceptions\InvalidEntityException
+	 * @throws \EventEspresso\core\exceptions\UnexpectedEntityException
+	 * @throws \EE_Error
+	 */
+	public function handle(CommandInterface $command)
+	{
+		/** @var CreateTicketLineItemCommand $command */
+		if (! $command instanceof CreateTicketLineItemCommand) {
+			throw new InvalidEntityException(get_class($command), 'CreateTicketLineItemCommand');
+		}
+		// create new line item for ticket
+		return $this->factory->create(
+			$command->transaction(),
+			$command->ticket(),
+			$command->quantity()
+		);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
     public function handle(CommandInterface $command)
     {
         /** @var CreateTicketLineItemCommand $command */
-        if (! $command instanceof CreateTicketLineItemCommand) {
+        if ( ! $command instanceof CreateTicketLineItemCommand) {
             throw new InvalidEntityException(get_class($command), 'CreateTicketLineItemCommand');
         }
         // create new line item for ticket

core/services/commands/ticket/CancelTicketLineItemCommand.php

Indentation +108 added lines, -108 removed lines

@@ -16,112 +16,112 @@
 {
 
 
-    /**
-     * @var \EE_Transaction $transaction
-     */
-    private $transaction;
-
-    /**
-     * @var \EE_Ticket $ticket
-     */
-    private $ticket;
-
-    /**
-     * @var \EE_Line_Item $ticket_line_item
-     */
-    protected $ticket_line_item;
-
-    /**
-     * @var int $quantity
-     */
-    protected $quantity;
-
-
-    /**
-     * @param \EE_Registration $registration
-     * @param int              $quantity
-     */
-    public static function fromRegistration(\EE_Registration $registration, $quantity = 1)
-    {
-        new self(
-            $registration->transaction(),
-            $registration->ticket(),
-            1,
-            $registration->ticket_line_item()
-        );
-    }
-
-
-    /**
-     * @param \EE_Line_Item $ticket_line_item
-     * @param int           $quantity
-     */
-    public static function fromTicketLineItem(
-        \EE_Line_Item $ticket_line_item,
-        $quantity = 1
-    ) {
-        new self(
-            $ticket_line_item->transaction(),
-            $ticket_line_item->ticket(),
-            $quantity,
-            $ticket_line_item
-        );
-    }
-
-
-    /**
-     * CancelTicketLineItemCommand constructor.
-     *
-     * @param \EE_Transaction $transaction
-     * @param \EE_Ticket      $ticket
-     * @param int             $quantity
-     * @param \EE_Line_Item   $ticket_line_item
-     */
-    public function __construct(
-        \EE_Transaction $transaction,
-        \EE_Ticket $ticket,
-        $quantity = 1,
-        \EE_Line_Item $ticket_line_item = null
-    ) {
-        $this->transaction = $transaction;
-        $this->ticket = $ticket;
-        $this->quantity = min(1, absint($quantity));
-        $this->ticket_line_item = $ticket_line_item;
-    }
-
-
-    /**
-     * @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 quantity()
-    {
-        return $this->quantity;
-    }
+	/**
+	 * @var \EE_Transaction $transaction
+	 */
+	private $transaction;
+
+	/**
+	 * @var \EE_Ticket $ticket
+	 */
+	private $ticket;
+
+	/**
+	 * @var \EE_Line_Item $ticket_line_item
+	 */
+	protected $ticket_line_item;
+
+	/**
+	 * @var int $quantity
+	 */
+	protected $quantity;
+
+
+	/**
+	 * @param \EE_Registration $registration
+	 * @param int              $quantity
+	 */
+	public static function fromRegistration(\EE_Registration $registration, $quantity = 1)
+	{
+		new self(
+			$registration->transaction(),
+			$registration->ticket(),
+			1,
+			$registration->ticket_line_item()
+		);
+	}
+
+
+	/**
+	 * @param \EE_Line_Item $ticket_line_item
+	 * @param int           $quantity
+	 */
+	public static function fromTicketLineItem(
+		\EE_Line_Item $ticket_line_item,
+		$quantity = 1
+	) {
+		new self(
+			$ticket_line_item->transaction(),
+			$ticket_line_item->ticket(),
+			$quantity,
+			$ticket_line_item
+		);
+	}
+
+
+	/**
+	 * CancelTicketLineItemCommand constructor.
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @param \EE_Ticket      $ticket
+	 * @param int             $quantity
+	 * @param \EE_Line_Item   $ticket_line_item
+	 */
+	public function __construct(
+		\EE_Transaction $transaction,
+		\EE_Ticket $ticket,
+		$quantity = 1,
+		\EE_Line_Item $ticket_line_item = null
+	) {
+		$this->transaction = $transaction;
+		$this->ticket = $ticket;
+		$this->quantity = min(1, absint($quantity));
+		$this->ticket_line_item = $ticket_line_item;
+	}
+
+
+	/**
+	 * @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 quantity()
+	{
+		return $this->quantity;
+	}
 }

core/services/commands/ticket/CancelTicketLineItemCommandHandler.php

Indentation +34 added lines, -34 removed lines

@@ -22,38 +22,38 @@
 {
 
 
-    /**
-     * @var CancelTicketLineItemService $cancel_ticket_line_item_service
-     */
-    private $cancel_ticket_line_item_service;
-
-
-    /**
-     * Command constructor
-     *
-     * @param CancelTicketLineItemService $cancel_ticket_line_item_service
-     */
-    public function __construct(CancelTicketLineItemService $cancel_ticket_line_item_service)
-    {
-        $this->cancel_ticket_line_item_service = $cancel_ticket_line_item_service;
-    }
-
-
-    /**
-     * @param \EventEspresso\core\services\commands\CommandInterface $command
-     * @return mixed
-     */
-    public function handle(CommandInterface $command)
-    {
-        /** @var CancelTicketLineItemCommand $command */
-        if (! $command instanceof CancelTicketLineItemCommand) {
-            throw new InvalidEntityException(get_class($command), 'CancelTicketLineItemCommand');
-        }
-        return $this->cancel_ticket_line_item_service->cancel(
-            $command->transaction(),
-            $command->ticket(),
-            $command->quantity(),
-            $command->ticketLineItem()
-        );
-    }
+	/**
+	 * @var CancelTicketLineItemService $cancel_ticket_line_item_service
+	 */
+	private $cancel_ticket_line_item_service;
+
+
+	/**
+	 * Command constructor
+	 *
+	 * @param CancelTicketLineItemService $cancel_ticket_line_item_service
+	 */
+	public function __construct(CancelTicketLineItemService $cancel_ticket_line_item_service)
+	{
+		$this->cancel_ticket_line_item_service = $cancel_ticket_line_item_service;
+	}
+
+
+	/**
+	 * @param \EventEspresso\core\services\commands\CommandInterface $command
+	 * @return mixed
+	 */
+	public function handle(CommandInterface $command)
+	{
+		/** @var CancelTicketLineItemCommand $command */
+		if (! $command instanceof CancelTicketLineItemCommand) {
+			throw new InvalidEntityException(get_class($command), 'CancelTicketLineItemCommand');
+		}
+		return $this->cancel_ticket_line_item_service->cancel(
+			$command->transaction(),
+			$command->ticket(),
+			$command->quantity(),
+			$command->ticketLineItem()
+		);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -51,7 +51,7 @@
     public function handle(CommandInterface $command)
     {
         /** @var CancelTicketLineItemCommand $command */
-        if (! $command instanceof CancelTicketLineItemCommand) {
+        if ( ! $command instanceof CancelTicketLineItemCommand) {
             throw new InvalidEntityException(get_class($command), 'CancelTicketLineItemCommand');
         }
         return $this->cancel_ticket_line_item_service->cancel(

core/services/commands/ticket/CreateTicketLineItemCommand.php

Indentation +73 added lines, -73 removed lines

@@ -16,77 +16,77 @@
 {
 
 
-    /**
-     * @var \EE_Transaction $transaction
-     */
-    private $transaction;
-
-    /**
-     * @var \EE_Ticket $ticket
-     */
-    private $ticket;
-
-    /**
-     * @var int $quantity
-     */
-    private $quantity = 1;
-
-    /**
-     * @var \EE_Line_Item $ticket_line_item
-     */
-    protected $ticket_line_item;
-
-
-    /**
-     * CreateTicketLineItemCommand constructor.
-     *
-     * @param \EE_Transaction $transaction
-     * @param \EE_Ticket      $ticket
-     * @param int             $quantity
-     */
-    public function __construct(
-        \EE_Transaction $transaction,
-        \EE_Ticket $ticket,
-        $quantity = 1
-    ) {
-        $this->transaction = $transaction;
-        $this->ticket = $ticket;
-        $this->quantity = $quantity;
-    }
-
-
-    /**
-     * @return \EE_Transaction
-     */
-    public function transaction()
-    {
-        return $this->transaction;
-    }
-
-
-    /**
-     * @return \EE_Ticket
-     */
-    public function ticket()
-    {
-        return $this->ticket;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function quantity()
-    {
-        return $this->quantity;
-    }
-
-
-    /**
-     * @return \EE_Line_Item
-     */
-    public function ticketLineItem()
-    {
-        return $this->ticket_line_item;
-    }
+	/**
+	 * @var \EE_Transaction $transaction
+	 */
+	private $transaction;
+
+	/**
+	 * @var \EE_Ticket $ticket
+	 */
+	private $ticket;
+
+	/**
+	 * @var int $quantity
+	 */
+	private $quantity = 1;
+
+	/**
+	 * @var \EE_Line_Item $ticket_line_item
+	 */
+	protected $ticket_line_item;
+
+
+	/**
+	 * CreateTicketLineItemCommand constructor.
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @param \EE_Ticket      $ticket
+	 * @param int             $quantity
+	 */
+	public function __construct(
+		\EE_Transaction $transaction,
+		\EE_Ticket $ticket,
+		$quantity = 1
+	) {
+		$this->transaction = $transaction;
+		$this->ticket = $ticket;
+		$this->quantity = $quantity;
+	}
+
+
+	/**
+	 * @return \EE_Transaction
+	 */
+	public function transaction()
+	{
+		return $this->transaction;
+	}
+
+
+	/**
+	 * @return \EE_Ticket
+	 */
+	public function ticket()
+	{
+		return $this->ticket;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function quantity()
+	{
+		return $this->quantity;
+	}
+
+
+	/**
+	 * @return \EE_Line_Item
+	 */
+	public function ticketLineItem()
+	{
+		return $this->ticket_line_item;
+	}
 }

core/services/commands/attendee/CreateAttendeeCommandHandler.php

Indentation +124 added lines, -124 removed lines

@@ -21,138 +21,138 @@
 {
 
 
-    /**
-     * @var EEM_Attendee $attendee_model
-     */
-    protected $attendee_model;
+	/**
+	 * @var EEM_Attendee $attendee_model
+	 */
+	protected $attendee_model;
 
 
-    /**
-     * @param EEM_Attendee $attendee_model
-     */
-    public function __construct(EEM_Attendee $attendee_model)
-    {
-        $this->attendee_model = $attendee_model;
-    }
+	/**
+	 * @param EEM_Attendee $attendee_model
+	 */
+	public function __construct(EEM_Attendee $attendee_model)
+	{
+		$this->attendee_model = $attendee_model;
+	}
 
 
-    /**
-     * @param CommandInterface $command
-     * @return EE_Attendee
-     * @throws EE_Error
-     * @throws InvalidEntityException
-     */
-    public function handle(CommandInterface $command)
-    {
-        /** @var CreateAttendeeCommand $command */
-        if (! $command instanceof CreateAttendeeCommand) {
-            throw new InvalidEntityException(get_class($command), 'CreateAttendeeCommand');
-        }
-        // have we met before?
-        $attendee = $this->findExistingAttendee(
-            $command->registration(),
-            $command->attendeeDetails()
-        );
-        // did we find an already existing record for this attendee ?
-        if ($attendee instanceof EE_Attendee) {
-            $attendee = $this->updateExistingAttendeeData(
-                $attendee,
-                $command->attendeeDetails()
-            );
-        } else {
-            $attendee = $this->createNewAttendee(
-                $command->registration(),
-                $command->attendeeDetails()
-            );
-        }
-        return $attendee;
-    }
+	/**
+	 * @param CommandInterface $command
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 * @throws InvalidEntityException
+	 */
+	public function handle(CommandInterface $command)
+	{
+		/** @var CreateAttendeeCommand $command */
+		if (! $command instanceof CreateAttendeeCommand) {
+			throw new InvalidEntityException(get_class($command), 'CreateAttendeeCommand');
+		}
+		// have we met before?
+		$attendee = $this->findExistingAttendee(
+			$command->registration(),
+			$command->attendeeDetails()
+		);
+		// did we find an already existing record for this attendee ?
+		if ($attendee instanceof EE_Attendee) {
+			$attendee = $this->updateExistingAttendeeData(
+				$attendee,
+				$command->attendeeDetails()
+			);
+		} else {
+			$attendee = $this->createNewAttendee(
+				$command->registration(),
+				$command->attendeeDetails()
+			);
+		}
+		return $attendee;
+	}
 
 
-    /**
-     * find_existing_attendee
-     *
-     * @param EE_Registration $registration
-     * @param  array          $attendee_data
-     * @return EE_Attendee
-     */
-    private function findExistingAttendee(EE_Registration $registration, array $attendee_data)
-    {
-        $existing_attendee = null;
-        // does this attendee already exist in the db ?
-        // we're searching using a combination of first name, last name, AND email address
-        $ATT_fname = ! empty($attendee_data['ATT_fname'])
-            ? $attendee_data['ATT_fname']
-            : '';
-        $ATT_lname = ! empty($attendee_data['ATT_lname'])
-            ? $attendee_data['ATT_lname']
-            : '';
-        $ATT_email = ! empty($attendee_data['ATT_email'])
-            ? $attendee_data['ATT_email']
-            : '';
-        // but only if those have values
-        if ($ATT_fname && $ATT_lname && $ATT_email) {
-            $existing_attendee = $this->attendee_model->find_existing_attendee(
-                array(
-                    'ATT_fname' => $ATT_fname,
-                    'ATT_lname' => $ATT_lname,
-                    'ATT_email' => $ATT_email,
-                )
-            );
-        }
-        return apply_filters(
-            'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
-            $existing_attendee,
-            $registration,
-            $attendee_data
-        );
-    }
+	/**
+	 * find_existing_attendee
+	 *
+	 * @param EE_Registration $registration
+	 * @param  array          $attendee_data
+	 * @return EE_Attendee
+	 */
+	private function findExistingAttendee(EE_Registration $registration, array $attendee_data)
+	{
+		$existing_attendee = null;
+		// does this attendee already exist in the db ?
+		// we're searching using a combination of first name, last name, AND email address
+		$ATT_fname = ! empty($attendee_data['ATT_fname'])
+			? $attendee_data['ATT_fname']
+			: '';
+		$ATT_lname = ! empty($attendee_data['ATT_lname'])
+			? $attendee_data['ATT_lname']
+			: '';
+		$ATT_email = ! empty($attendee_data['ATT_email'])
+			? $attendee_data['ATT_email']
+			: '';
+		// but only if those have values
+		if ($ATT_fname && $ATT_lname && $ATT_email) {
+			$existing_attendee = $this->attendee_model->find_existing_attendee(
+				array(
+					'ATT_fname' => $ATT_fname,
+					'ATT_lname' => $ATT_lname,
+					'ATT_email' => $ATT_email,
+				)
+			);
+		}
+		return apply_filters(
+			'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
+			$existing_attendee,
+			$registration,
+			$attendee_data
+		);
+	}
 
 
-    /**
-     * _update_existing_attendee_data
-     * in case it has changed since last time they registered for an event
-     *
-     * @param EE_Attendee $existing_attendee
-     * @param  array      $attendee_data
-     * @return EE_Attendee
-     * @throws EE_Error
-     */
-    private function updateExistingAttendeeData(EE_Attendee $existing_attendee, array $attendee_data)
-    {
-        // first remove fname, lname, and email from attendee data
-        // because these properties will be exactly the same as the returned attendee object,
-        // since they were used in the query to get the attendee object in the first place
-        $dont_set = array('ATT_fname', 'ATT_lname', 'ATT_email');
-        // now loop thru what's left and add to attendee CPT
-        foreach ($attendee_data as $property_name => $property_value) {
-            if (! in_array($property_name, $dont_set, true)
-                && $this->attendee_model->has_field($property_name)
-            ) {
-                $existing_attendee->set($property_name, $property_value);
-            }
-        }
-        // better save that now
-        $existing_attendee->save();
-        return $existing_attendee;
-    }
+	/**
+	 * _update_existing_attendee_data
+	 * in case it has changed since last time they registered for an event
+	 *
+	 * @param EE_Attendee $existing_attendee
+	 * @param  array      $attendee_data
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 */
+	private function updateExistingAttendeeData(EE_Attendee $existing_attendee, array $attendee_data)
+	{
+		// first remove fname, lname, and email from attendee data
+		// because these properties will be exactly the same as the returned attendee object,
+		// since they were used in the query to get the attendee object in the first place
+		$dont_set = array('ATT_fname', 'ATT_lname', 'ATT_email');
+		// now loop thru what's left and add to attendee CPT
+		foreach ($attendee_data as $property_name => $property_value) {
+			if (! in_array($property_name, $dont_set, true)
+				&& $this->attendee_model->has_field($property_name)
+			) {
+				$existing_attendee->set($property_name, $property_value);
+			}
+		}
+		// better save that now
+		$existing_attendee->save();
+		return $existing_attendee;
+	}
 
 
-    /**
-     * create_new_attendee
-     *
-     * @param EE_Registration $registration
-     * @param  array          $attendee_data
-     * @return EE_Attendee
-     * @throws EE_Error
-     */
-    private function createNewAttendee(EE_Registration $registration, array $attendee_data)
-    {
-        // create new attendee object
-        $new_attendee = EE_Attendee::new_instance($attendee_data);
-        // set author to event creator
-        $new_attendee->set('ATT_author', $registration->event()->wp_user());
-        $new_attendee->save();
-        return $new_attendee;
-    }
+	/**
+	 * create_new_attendee
+	 *
+	 * @param EE_Registration $registration
+	 * @param  array          $attendee_data
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 */
+	private function createNewAttendee(EE_Registration $registration, array $attendee_data)
+	{
+		// create new attendee object
+		$new_attendee = EE_Attendee::new_instance($attendee_data);
+		// set author to event creator
+		$new_attendee->set('ATT_author', $registration->event()->wp_user());
+		$new_attendee->save();
+		return $new_attendee;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -45,7 +45,7 @@ 
     public function handle(CommandInterface $command)
     {
         /** @var CreateAttendeeCommand $command */
-        if (! $command instanceof CreateAttendeeCommand) {
+        if ( ! $command instanceof CreateAttendeeCommand) {
             throw new InvalidEntityException(get_class($command), 'CreateAttendeeCommand');
         }
         // have we met before?
@@ -126,7 +126,7 @@ 
         $dont_set = array('ATT_fname', 'ATT_lname', 'ATT_email');
         // now loop thru what's left and add to attendee CPT
         foreach ($attendee_data as $property_name => $property_value) {
-            if (! in_array($property_name, $dont_set, true)
+            if ( ! in_array($property_name, $dont_set, true)
                 && $this->attendee_model->has_field($property_name)
             ) {
                 $existing_attendee->set($property_name, $property_value);

core/services/commands/attendee/CreateAttendeeCommand.php

Indentation +49 added lines, -49 removed lines

@@ -20,62 +20,62 @@
 class CreateAttendeeCommand extends Command implements CommandRequiresCapCheckInterface
 {
 
-    /**
-     * array of details where keys are names of EEM_Attendee model fields
-     *
-     * @var array $attendee_details
-     */
-    protected $attendee_details;
+	/**
+	 * array of details where keys are names of EEM_Attendee model fields
+	 *
+	 * @var array $attendee_details
+	 */
+	protected $attendee_details;
 
-    /**
-     * an existing registration to associate this attendee with
-     *
-     * @var EE_Registration $registration
-     */
-    protected $registration;
+	/**
+	 * an existing registration to associate this attendee with
+	 *
+	 * @var EE_Registration $registration
+	 */
+	protected $registration;
 
 
-    /**
-     * CreateAttendeeCommand constructor.
-     *
-     * @param array           $attendee_details
-     * @param EE_Registration $registration
-     */
-    public function __construct(array $attendee_details, EE_Registration $registration)
-    {
-        $this->attendee_details = $attendee_details;
-        $this->registration = $registration;
-    }
+	/**
+	 * CreateAttendeeCommand constructor.
+	 *
+	 * @param array           $attendee_details
+	 * @param EE_Registration $registration
+	 */
+	public function __construct(array $attendee_details, EE_Registration $registration)
+	{
+		$this->attendee_details = $attendee_details;
+		$this->registration = $registration;
+	}
 
 
-    /**
-     * @return array
-     */
-    public function attendeeDetails()
-    {
-        return $this->attendee_details;
-    }
+	/**
+	 * @return array
+	 */
+	public function attendeeDetails()
+	{
+		return $this->attendee_details;
+	}
 
 
-    /**
-     * @return EE_Registration
-     */
-    public function registration()
-    {
-        return $this->registration;
-    }
+	/**
+	 * @return EE_Registration
+	 */
+	public function registration()
+	{
+		return $this->registration;
+	}
 
 
-    /**
-     * @return CapCheckInterface
-     * @throws InvalidDataTypeException
-     */
-    public function getCapCheck()
-    {
-        // need cap for non-AJAX admin requests
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
-            return new CapCheck('ee_edit_contacts', 'create_new_contact');
-        }
-        return new PublicCapabilities('', 'create_new_contact');
-    }
+	/**
+	 * @return CapCheckInterface
+	 * @throws InvalidDataTypeException
+	 */
+	public function getCapCheck()
+	{
+		// need cap for non-AJAX admin requests
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+			return new CapCheck('ee_edit_contacts', 'create_new_contact');
+		}
+		return new PublicCapabilities('', 'create_new_contact');
+	}
 }

core/CPTs/CptQueryModifier.php

Indentation +540 added lines, -540 removed lines

@@ -17,544 +17,544 @@
 class CptQueryModifier
 {
 
-    /**
-     * @var string $post_type
-     */
-    protected $post_type = '';
-
-    /**
-     * CPT details from CustomPostTypeDefinitions for specific post type
-     *
-     * @var array $cpt_details
-     */
-    protected $cpt_details = array();
-
-    /**
-     * @var \EE_Table_Base[] $model_tables
-     */
-    protected $model_tables = array();
-
-    /**
-     * @var array $taxonomies
-     */
-    protected $taxonomies = array();
-
-    /**
-     * meta table for the related CPT
-     *
-     * @var \EE_Secondary_Table $meta_table
-     */
-    protected $meta_table;
-
-    /**
-     * EEM_CPT_Base model for the related CPT
-     *
-     * @var \EEM_CPT_Base $model
-     */
-    protected $model;
-
-    /**
-     * @var \EE_Request_Handler $request
-     */
-    protected $request;
-
-    /**
-     * @var \WP_Query $wp_query
-     */
-    protected $wp_query;
-
-
-    /**
-     * CptQueryModifier constructor
-     *
-     * @param string              $post_type
-     * @param array               $cpt_details
-     * @param \WP_Query           $WP_Query
-     * @param \EE_Request_Handler $request
-     */
-    public function __construct(
-        $post_type,
-        array $cpt_details,
-        \WP_Query $WP_Query,
-        \EE_Request_Handler $request
-    ) {
-        $this->setRequest($request);
-        $this->setWpQuery($WP_Query);
-        $this->setPostType($post_type);
-        $this->setCptDetails($cpt_details);
-        $this->init();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function postType()
-    {
-        return $this->post_type;
-    }
-
-
-    /**
-     * @param string $post_type
-     */
-    protected function setPostType($post_type)
-    {
-        $this->post_type = $post_type;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function cptDetails()
-    {
-        return $this->cpt_details;
-    }
-
-
-    /**
-     * @param array $cpt_details
-     */
-    protected function setCptDetails($cpt_details)
-    {
-        $this->cpt_details = $cpt_details;
-    }
-
-
-    /**
-     * @return \EE_Table_Base[]
-     */
-    public function modelTables()
-    {
-        return $this->model_tables;
-    }
-
-
-    /**
-     * @param \EE_Table_Base[] $model_tables
-     */
-    protected function setModelTables($model_tables)
-    {
-        $this->model_tables = $model_tables;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function taxonomies()
-    {
-        if (empty($this->taxonomies)) {
-            $this->initializeTaxonomies();
-        }
-        return $this->taxonomies;
-    }
-
-
-    /**
-     * @param array $taxonomies
-     */
-    protected function setTaxonomies(array $taxonomies)
-    {
-        $this->taxonomies = $taxonomies;
-    }
-
-
-    /**
-     * @return \EE_Secondary_Table
-     */
-    public function metaTable()
-    {
-        return $this->meta_table;
-    }
-
-
-    /**
-     * @param \EE_Secondary_Table $meta_table
-     */
-    public function setMetaTable(\EE_Secondary_Table $meta_table)
-    {
-        $this->meta_table = $meta_table;
-    }
-
-
-    /**
-     * @return \EEM_Base
-     */
-    public function model()
-    {
-        return $this->model;
-    }
-
-
-    /**
-     * @param \EEM_Base $CPT_model
-     */
-    protected function setModel(\EEM_Base $CPT_model)
-    {
-        $this->model = $CPT_model;
-    }
-
-
-    /**
-     * @return \EE_Request_Handler
-     */
-    public function request()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * @param \EE_Request_Handler $request
-     */
-    protected function setRequest(\EE_Request_Handler $request)
-    {
-        $this->request = $request;
-    }
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    /**
-     * @return \WP_Query
-     */
-    public function WpQuery()
-    {
-        return $this->wp_query;
-    }
-    // phpcs:enable
-
-    /**
-     * @param \WP_Query $wp_query
-     */
-    public function setWpQuery(\WP_Query $wp_query)
-    {
-        $this->wp_query = $wp_query;
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function initializeTaxonomies()
-    {
-        // check if taxonomies have already been set and that this CPT has taxonomies registered for it
-        if (empty($this->taxonomies)
-            && isset($this->cpt_details['args']['taxonomies'])
-        ) {
-            // if so then grab them, but we want the taxonomy name as the key
-            $taxonomies = array_flip($this->cpt_details['args']['taxonomies']);
-            // then grab the list of ALL taxonomies
-            /** @var \EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions
-             * $taxonomy_definitions
-             */
-            $taxonomy_definitions = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions'
-            );
-            $all_taxonomies = $taxonomy_definitions->getCustomTaxonomyDefinitions();
-            foreach ($taxonomies as $taxonomy => &$details) {
-                // add details to our taxonomies if they exist
-                $details = isset($all_taxonomies[$taxonomy])
-                    ? $all_taxonomies[$taxonomy]
-                    : array();
-            }
-            // ALWAYS unset() variables that were passed by reference
-            unset($details);
-            $this->setTaxonomies($taxonomies);
-        }
-    }
-
-
-    protected function init()
-    {
-        $this->setAdditionalCptDetails();
-        $this->setRequestVarsIfCpt();
-        // convert post_type to model name
-        $model_name = str_replace('EE_', '', $this->cpt_details['class_name']);
-        // load all tables related to CPT
-        $this->setupModelsAndTables($model_name);
-        // load and instantiate CPT_*_Strategy
-        $CPT_Strategy = $this->cptStrategyClass($model_name);
-        // !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
-        // here's the list of available filters in the WP_Query object
-        // 'posts_where_paged'
-        // 'posts_groupby'
-        // 'posts_join_paged'
-        // 'posts_orderby'
-        // 'posts_distinct'
-        // 'post_limits'
-        // 'posts_fields'
-        // 'posts_join'
-        add_filter('posts_fields', array($this, 'postsFields'));
-        add_filter('posts_join', array($this, 'postsJoin'));
-        add_filter(
-            'get_' . $this->post_type . '_metadata',
-            array($CPT_Strategy, 'get_EE_post_type_metadata'),
-            1,
-            4
-        );
-        add_filter('the_posts', array($this, 'thePosts'), 1, 1);
-        if ($this->wp_query->is_main_query()) {
-            add_filter('get_edit_post_link', array($this, 'getEditPostLink'), 10, 2);
-            $this->addTemplateFilters();
-        }
-    }
-
-
-    /**
-     * sets some basic query vars that pertain to the CPT
-     *
-     * @access protected
-     * @return void
-     */
-    protected function setAdditionalCptDetails()
-    {
-        // the post or category or term that is triggering EE
-        $this->cpt_details['espresso_page'] = $this->request->is_espresso_page();
-        // requested post name
-        $this->cpt_details['post_name'] = $this->request->get('post_name');
-        // add support for viewing 'private', 'draft', or 'pending' posts
-        if (isset($this->wp_query->query_vars['p'])
-            && $this->wp_query->query_vars['p'] !== 0
-            && is_user_logged_in()
-            && current_user_can('edit_post', $this->wp_query->query_vars['p'])
-        ) {
-            // we can just inject directly into the WP_Query object
-            $this->wp_query->query['post_status'] = array('publish', 'private', 'draft', 'pending');
-            // now set the main 'ee' request var so that the appropriate module can load the appropriate template(s)
-            $this->request->set('ee', $this->cpt_details['singular_slug']);
-        }
-    }
-
-
-    /**
-     * Checks if we're on a EE-CPT archive-or-single page, and if we've never set the EE request var.
-     * If so, sets the 'ee' request variable
-     * so other parts of EE can know what CPT is getting queried.
-     * To Mike's knowledge, this must be called from during or after the pre_get_posts hook
-     * in order for is_archive() and is_single() methods to work properly.
-     *
-     * @return void
-     */
-    public function setRequestVarsIfCpt()
-    {
-        // check if ee action var has been set
-        if (! $this->request->is_set('ee')) {
-            // check that route exists for CPT archive slug
-            if (is_archive() && \EE_Config::get_route($this->cpt_details['plural_slug'])) {
-                // ie: set "ee" to "events"
-                $this->request->set('ee', $this->cpt_details['plural_slug']);
-                // or does it match a single page CPT like /event/
-            } else if (is_single() && \EE_Config::get_route($this->cpt_details['singular_slug'])) {
-                // ie: set "ee" to "event"
-                $this->request->set('ee', $this->cpt_details['singular_slug']);
-            }
-        }
-    }
-
-
-    /**
-     * setupModelsAndTables
-     *
-     * @access protected
-     * @param string $model_name
-     * @throws \EE_Error
-     */
-    protected function setupModelsAndTables($model_name)
-    {
-        // get CPT table data via CPT Model
-        $model = \EE_Registry::instance()->load_model($model_name);
-        if (! $model instanceof \EEM_Base) {
-            throw new \EE_Error(
-                sprintf(
-                    __(
-                        'The "%1$s" model could not be loaded.',
-                        'event_espresso'
-                    ),
-                    $model_name
-                )
-            );
-        }
-        $this->setModel($model);
-        $this->setModelTables($this->model->get_tables());
-        // is there a Meta Table for this CPT?
-        if (isset($this->cpt_details['tables'][$model_name . '_Meta'])
-            && $this->cpt_details['tables'][$model_name . '_Meta'] instanceof \EE_Secondary_Table
-        ) {
-            $this->setMetaTable($this->cpt_details['tables'][$model_name . '_Meta']);
-        }
-    }
-
-
-    /**
-     * cptStrategyClass
-     *
-     * @access protected
-     * @param  string $model_name
-     * @return string
-     */
-    protected function cptStrategyClass($model_name)
-    {
-        // creates classname like:  CPT_Event_Strategy
-        $CPT_Strategy_class_name = 'CPT_' . $model_name . '_Strategy';
-        // load and instantiate
-        $CPT_Strategy = \EE_Registry::instance()->load_core(
-            $CPT_Strategy_class_name,
-            array('WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details)
-        );
-        if ($CPT_Strategy === null) {
-            $CPT_Strategy = \EE_Registry::instance()->load_core(
-                'CPT_Default_Strategy',
-                array('WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details)
-            );
-        }
-        return $CPT_Strategy;
-    }
-
-
-    /**
-     * postsFields
-     *
-     * @access public
-     * @param  $SQL
-     * @return string
-     */
-    public function postsFields($SQL)
-    {
-        // does this CPT have a meta table ?
-        if ($this->meta_table instanceof \EE_Secondary_Table) {
-            // adds something like ", wp_esp_event_meta.* " to WP Query SELECT statement
-            $SQL .= ', ' . $this->meta_table->get_table_name() . '.* ';
-        }
-        remove_filter('posts_fields', array($this, 'postsFields'));
-        return $SQL;
-    }
-
-
-    /**
-     * postsJoin
-     *
-     * @access public
-     * @param  $SQL
-     * @return string
-     */
-    public function postsJoin($SQL)
-    {
-        // does this CPT have a meta table ?
-        if ($this->meta_table instanceof \EE_Secondary_Table) {
-            global $wpdb;
-            // adds something like " LEFT JOIN wp_esp_event_meta ON ( wp_esp_event_meta.EVT_ID = wp_posts.ID ) " to WP Query JOIN statement
-            $SQL .= ' LEFT JOIN '
-                    . $this->meta_table->get_table_name()
-                    . ' ON ( '
-                    . $this->meta_table->get_table_name()
-                    . '.'
-                    . $this->meta_table->get_fk_on_table()
-                    . ' = '
-                    . $wpdb->posts
-                    . '.ID ) ';
-        }
-        remove_filter('posts_join', array($this, 'postsJoin'));
-        return $SQL;
-    }
-
-
-    /**
-     * thePosts
-     *
-     * @access public
-     * @param  \WP_Post[] $posts
-     * @return \WP_Post[]
-     */
-    public function thePosts($posts)
-    {
-        $CPT_class = $this->cpt_details['class_name'];
-        // loop thru posts
-        if (is_array($posts) && $this->model instanceof \EEM_CPT_Base) {
-            foreach ($posts as $key => $post) {
-                if ($post->post_type === $this->post_type) {
-                    $post->{$CPT_class} = $this->model->instantiate_class_from_post_object($post);
-                }
-            }
-        }
-        remove_filter('the_posts', array($this, 'thePosts'), 1);
-        return $posts;
-    }
-
-
-    /**
-     * @param $url
-     * @param $ID
-     * @return string
-     */
-    public function getEditPostLink($url, $ID)
-    {
-        // need to make sure we only edit links if our cpt
-        global $post;
-        // notice if the cpt is registered with `show_ee_ui` set to false, we take that to mean that the WordPress core ui
-        // for interacting with the CPT is desired and there is no EE UI for interacting with the CPT in the admin.
-        if (! $post instanceof \WP_Post
-            || $post->post_type !== $this->post_type
-            || (
-                isset($this->cpt_details['args']['show_ee_ui'])
-                && ! $this->cpt_details['args']['show_ee_ui']
-            )
-        ) {
-            return $url;
-        }
-        // k made it here so all is good.
-        return wp_nonce_url(
-            add_query_arg(
-                array('page' => $this->post_type, 'post' => $ID, 'action' => 'edit'),
-                admin_url('admin.php')
-            ),
-            'edit',
-            'edit_nonce'
-        );
-    }
-
-
-    /**
-     * Execute any template filters.
-     * This method is only called if in main query.
-     *
-     * @return void
-     */
-    public function addTemplateFilters()
-    {
-        // if requested cpt supports page_templates and it's the main query
-        if (! empty($this->cpt_details['args']['page_templates']) && $this->wp_query->is_main_query()) {
-            // then let's hook into the appropriate query_template hook
-            add_filter('single_template', array($this, 'singleCptTemplate'));
-        }
-    }
-
-
-    /**
-     * Callback for single_template wp filter.
-     * This is used to load the set page_template for a single ee cpt if its set.  If "default" then we load the normal
-     * hierarchy.
-     *
-     * @access public
-     * @param string $current_template Existing default template path derived for this page call.
-     * @return string the path to the full template file.
-     */
-    public function singleCptTemplate($current_template)
-    {
-        $object = get_queried_object();
-        // does this called object HAVE a page template set that is something other than the default.
-        $template = get_post_meta($object->ID, '_wp_page_template', true);
-        // exit early if default or not set or invalid path (accounts for theme changes)
-        if ($template === 'default'
-            || empty($template)
-            || ! is_readable(get_stylesheet_directory() . '/' . $template)
-        ) {
-            return $current_template;
-        }
-        // made it here so we SHOULD be able to just locate the template and then return it.
-        return locate_template(array($template));
-    }
+	/**
+	 * @var string $post_type
+	 */
+	protected $post_type = '';
+
+	/**
+	 * CPT details from CustomPostTypeDefinitions for specific post type
+	 *
+	 * @var array $cpt_details
+	 */
+	protected $cpt_details = array();
+
+	/**
+	 * @var \EE_Table_Base[] $model_tables
+	 */
+	protected $model_tables = array();
+
+	/**
+	 * @var array $taxonomies
+	 */
+	protected $taxonomies = array();
+
+	/**
+	 * meta table for the related CPT
+	 *
+	 * @var \EE_Secondary_Table $meta_table
+	 */
+	protected $meta_table;
+
+	/**
+	 * EEM_CPT_Base model for the related CPT
+	 *
+	 * @var \EEM_CPT_Base $model
+	 */
+	protected $model;
+
+	/**
+	 * @var \EE_Request_Handler $request
+	 */
+	protected $request;
+
+	/**
+	 * @var \WP_Query $wp_query
+	 */
+	protected $wp_query;
+
+
+	/**
+	 * CptQueryModifier constructor
+	 *
+	 * @param string              $post_type
+	 * @param array               $cpt_details
+	 * @param \WP_Query           $WP_Query
+	 * @param \EE_Request_Handler $request
+	 */
+	public function __construct(
+		$post_type,
+		array $cpt_details,
+		\WP_Query $WP_Query,
+		\EE_Request_Handler $request
+	) {
+		$this->setRequest($request);
+		$this->setWpQuery($WP_Query);
+		$this->setPostType($post_type);
+		$this->setCptDetails($cpt_details);
+		$this->init();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function postType()
+	{
+		return $this->post_type;
+	}
+
+
+	/**
+	 * @param string $post_type
+	 */
+	protected function setPostType($post_type)
+	{
+		$this->post_type = $post_type;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function cptDetails()
+	{
+		return $this->cpt_details;
+	}
+
+
+	/**
+	 * @param array $cpt_details
+	 */
+	protected function setCptDetails($cpt_details)
+	{
+		$this->cpt_details = $cpt_details;
+	}
+
+
+	/**
+	 * @return \EE_Table_Base[]
+	 */
+	public function modelTables()
+	{
+		return $this->model_tables;
+	}
+
+
+	/**
+	 * @param \EE_Table_Base[] $model_tables
+	 */
+	protected function setModelTables($model_tables)
+	{
+		$this->model_tables = $model_tables;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function taxonomies()
+	{
+		if (empty($this->taxonomies)) {
+			$this->initializeTaxonomies();
+		}
+		return $this->taxonomies;
+	}
+
+
+	/**
+	 * @param array $taxonomies
+	 */
+	protected function setTaxonomies(array $taxonomies)
+	{
+		$this->taxonomies = $taxonomies;
+	}
+
+
+	/**
+	 * @return \EE_Secondary_Table
+	 */
+	public function metaTable()
+	{
+		return $this->meta_table;
+	}
+
+
+	/**
+	 * @param \EE_Secondary_Table $meta_table
+	 */
+	public function setMetaTable(\EE_Secondary_Table $meta_table)
+	{
+		$this->meta_table = $meta_table;
+	}
+
+
+	/**
+	 * @return \EEM_Base
+	 */
+	public function model()
+	{
+		return $this->model;
+	}
+
+
+	/**
+	 * @param \EEM_Base $CPT_model
+	 */
+	protected function setModel(\EEM_Base $CPT_model)
+	{
+		$this->model = $CPT_model;
+	}
+
+
+	/**
+	 * @return \EE_Request_Handler
+	 */
+	public function request()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * @param \EE_Request_Handler $request
+	 */
+	protected function setRequest(\EE_Request_Handler $request)
+	{
+		$this->request = $request;
+	}
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	/**
+	 * @return \WP_Query
+	 */
+	public function WpQuery()
+	{
+		return $this->wp_query;
+	}
+	// phpcs:enable
+
+	/**
+	 * @param \WP_Query $wp_query
+	 */
+	public function setWpQuery(\WP_Query $wp_query)
+	{
+		$this->wp_query = $wp_query;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function initializeTaxonomies()
+	{
+		// check if taxonomies have already been set and that this CPT has taxonomies registered for it
+		if (empty($this->taxonomies)
+			&& isset($this->cpt_details['args']['taxonomies'])
+		) {
+			// if so then grab them, but we want the taxonomy name as the key
+			$taxonomies = array_flip($this->cpt_details['args']['taxonomies']);
+			// then grab the list of ALL taxonomies
+			/** @var \EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions
+			 * $taxonomy_definitions
+			 */
+			$taxonomy_definitions = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions'
+			);
+			$all_taxonomies = $taxonomy_definitions->getCustomTaxonomyDefinitions();
+			foreach ($taxonomies as $taxonomy => &$details) {
+				// add details to our taxonomies if they exist
+				$details = isset($all_taxonomies[$taxonomy])
+					? $all_taxonomies[$taxonomy]
+					: array();
+			}
+			// ALWAYS unset() variables that were passed by reference
+			unset($details);
+			$this->setTaxonomies($taxonomies);
+		}
+	}
+
+
+	protected function init()
+	{
+		$this->setAdditionalCptDetails();
+		$this->setRequestVarsIfCpt();
+		// convert post_type to model name
+		$model_name = str_replace('EE_', '', $this->cpt_details['class_name']);
+		// load all tables related to CPT
+		$this->setupModelsAndTables($model_name);
+		// load and instantiate CPT_*_Strategy
+		$CPT_Strategy = $this->cptStrategyClass($model_name);
+		// !!!!!!!!!!  IMPORTANT !!!!!!!!!!!!
+		// here's the list of available filters in the WP_Query object
+		// 'posts_where_paged'
+		// 'posts_groupby'
+		// 'posts_join_paged'
+		// 'posts_orderby'
+		// 'posts_distinct'
+		// 'post_limits'
+		// 'posts_fields'
+		// 'posts_join'
+		add_filter('posts_fields', array($this, 'postsFields'));
+		add_filter('posts_join', array($this, 'postsJoin'));
+		add_filter(
+			'get_' . $this->post_type . '_metadata',
+			array($CPT_Strategy, 'get_EE_post_type_metadata'),
+			1,
+			4
+		);
+		add_filter('the_posts', array($this, 'thePosts'), 1, 1);
+		if ($this->wp_query->is_main_query()) {
+			add_filter('get_edit_post_link', array($this, 'getEditPostLink'), 10, 2);
+			$this->addTemplateFilters();
+		}
+	}
+
+
+	/**
+	 * sets some basic query vars that pertain to the CPT
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function setAdditionalCptDetails()
+	{
+		// the post or category or term that is triggering EE
+		$this->cpt_details['espresso_page'] = $this->request->is_espresso_page();
+		// requested post name
+		$this->cpt_details['post_name'] = $this->request->get('post_name');
+		// add support for viewing 'private', 'draft', or 'pending' posts
+		if (isset($this->wp_query->query_vars['p'])
+			&& $this->wp_query->query_vars['p'] !== 0
+			&& is_user_logged_in()
+			&& current_user_can('edit_post', $this->wp_query->query_vars['p'])
+		) {
+			// we can just inject directly into the WP_Query object
+			$this->wp_query->query['post_status'] = array('publish', 'private', 'draft', 'pending');
+			// now set the main 'ee' request var so that the appropriate module can load the appropriate template(s)
+			$this->request->set('ee', $this->cpt_details['singular_slug']);
+		}
+	}
+
+
+	/**
+	 * Checks if we're on a EE-CPT archive-or-single page, and if we've never set the EE request var.
+	 * If so, sets the 'ee' request variable
+	 * so other parts of EE can know what CPT is getting queried.
+	 * To Mike's knowledge, this must be called from during or after the pre_get_posts hook
+	 * in order for is_archive() and is_single() methods to work properly.
+	 *
+	 * @return void
+	 */
+	public function setRequestVarsIfCpt()
+	{
+		// check if ee action var has been set
+		if (! $this->request->is_set('ee')) {
+			// check that route exists for CPT archive slug
+			if (is_archive() && \EE_Config::get_route($this->cpt_details['plural_slug'])) {
+				// ie: set "ee" to "events"
+				$this->request->set('ee', $this->cpt_details['plural_slug']);
+				// or does it match a single page CPT like /event/
+			} else if (is_single() && \EE_Config::get_route($this->cpt_details['singular_slug'])) {
+				// ie: set "ee" to "event"
+				$this->request->set('ee', $this->cpt_details['singular_slug']);
+			}
+		}
+	}
+
+
+	/**
+	 * setupModelsAndTables
+	 *
+	 * @access protected
+	 * @param string $model_name
+	 * @throws \EE_Error
+	 */
+	protected function setupModelsAndTables($model_name)
+	{
+		// get CPT table data via CPT Model
+		$model = \EE_Registry::instance()->load_model($model_name);
+		if (! $model instanceof \EEM_Base) {
+			throw new \EE_Error(
+				sprintf(
+					__(
+						'The "%1$s" model could not be loaded.',
+						'event_espresso'
+					),
+					$model_name
+				)
+			);
+		}
+		$this->setModel($model);
+		$this->setModelTables($this->model->get_tables());
+		// is there a Meta Table for this CPT?
+		if (isset($this->cpt_details['tables'][$model_name . '_Meta'])
+			&& $this->cpt_details['tables'][$model_name . '_Meta'] instanceof \EE_Secondary_Table
+		) {
+			$this->setMetaTable($this->cpt_details['tables'][$model_name . '_Meta']);
+		}
+	}
+
+
+	/**
+	 * cptStrategyClass
+	 *
+	 * @access protected
+	 * @param  string $model_name
+	 * @return string
+	 */
+	protected function cptStrategyClass($model_name)
+	{
+		// creates classname like:  CPT_Event_Strategy
+		$CPT_Strategy_class_name = 'CPT_' . $model_name . '_Strategy';
+		// load and instantiate
+		$CPT_Strategy = \EE_Registry::instance()->load_core(
+			$CPT_Strategy_class_name,
+			array('WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details)
+		);
+		if ($CPT_Strategy === null) {
+			$CPT_Strategy = \EE_Registry::instance()->load_core(
+				'CPT_Default_Strategy',
+				array('WP_Query' => $this->wp_query, 'CPT' => $this->cpt_details)
+			);
+		}
+		return $CPT_Strategy;
+	}
+
+
+	/**
+	 * postsFields
+	 *
+	 * @access public
+	 * @param  $SQL
+	 * @return string
+	 */
+	public function postsFields($SQL)
+	{
+		// does this CPT have a meta table ?
+		if ($this->meta_table instanceof \EE_Secondary_Table) {
+			// adds something like ", wp_esp_event_meta.* " to WP Query SELECT statement
+			$SQL .= ', ' . $this->meta_table->get_table_name() . '.* ';
+		}
+		remove_filter('posts_fields', array($this, 'postsFields'));
+		return $SQL;
+	}
+
+
+	/**
+	 * postsJoin
+	 *
+	 * @access public
+	 * @param  $SQL
+	 * @return string
+	 */
+	public function postsJoin($SQL)
+	{
+		// does this CPT have a meta table ?
+		if ($this->meta_table instanceof \EE_Secondary_Table) {
+			global $wpdb;
+			// adds something like " LEFT JOIN wp_esp_event_meta ON ( wp_esp_event_meta.EVT_ID = wp_posts.ID ) " to WP Query JOIN statement
+			$SQL .= ' LEFT JOIN '
+					. $this->meta_table->get_table_name()
+					. ' ON ( '
+					. $this->meta_table->get_table_name()
+					. '.'
+					. $this->meta_table->get_fk_on_table()
+					. ' = '
+					. $wpdb->posts
+					. '.ID ) ';
+		}
+		remove_filter('posts_join', array($this, 'postsJoin'));
+		return $SQL;
+	}
+
+
+	/**
+	 * thePosts
+	 *
+	 * @access public
+	 * @param  \WP_Post[] $posts
+	 * @return \WP_Post[]
+	 */
+	public function thePosts($posts)
+	{
+		$CPT_class = $this->cpt_details['class_name'];
+		// loop thru posts
+		if (is_array($posts) && $this->model instanceof \EEM_CPT_Base) {
+			foreach ($posts as $key => $post) {
+				if ($post->post_type === $this->post_type) {
+					$post->{$CPT_class} = $this->model->instantiate_class_from_post_object($post);
+				}
+			}
+		}
+		remove_filter('the_posts', array($this, 'thePosts'), 1);
+		return $posts;
+	}
+
+
+	/**
+	 * @param $url
+	 * @param $ID
+	 * @return string
+	 */
+	public function getEditPostLink($url, $ID)
+	{
+		// need to make sure we only edit links if our cpt
+		global $post;
+		// notice if the cpt is registered with `show_ee_ui` set to false, we take that to mean that the WordPress core ui
+		// for interacting with the CPT is desired and there is no EE UI for interacting with the CPT in the admin.
+		if (! $post instanceof \WP_Post
+			|| $post->post_type !== $this->post_type
+			|| (
+				isset($this->cpt_details['args']['show_ee_ui'])
+				&& ! $this->cpt_details['args']['show_ee_ui']
+			)
+		) {
+			return $url;
+		}
+		// k made it here so all is good.
+		return wp_nonce_url(
+			add_query_arg(
+				array('page' => $this->post_type, 'post' => $ID, 'action' => 'edit'),
+				admin_url('admin.php')
+			),
+			'edit',
+			'edit_nonce'
+		);
+	}
+
+
+	/**
+	 * Execute any template filters.
+	 * This method is only called if in main query.
+	 *
+	 * @return void
+	 */
+	public function addTemplateFilters()
+	{
+		// if requested cpt supports page_templates and it's the main query
+		if (! empty($this->cpt_details['args']['page_templates']) && $this->wp_query->is_main_query()) {
+			// then let's hook into the appropriate query_template hook
+			add_filter('single_template', array($this, 'singleCptTemplate'));
+		}
+	}
+
+
+	/**
+	 * Callback for single_template wp filter.
+	 * This is used to load the set page_template for a single ee cpt if its set.  If "default" then we load the normal
+	 * hierarchy.
+	 *
+	 * @access public
+	 * @param string $current_template Existing default template path derived for this page call.
+	 * @return string the path to the full template file.
+	 */
+	public function singleCptTemplate($current_template)
+	{
+		$object = get_queried_object();
+		// does this called object HAVE a page template set that is something other than the default.
+		$template = get_post_meta($object->ID, '_wp_page_template', true);
+		// exit early if default or not set or invalid path (accounts for theme changes)
+		if ($template === 'default'
+			|| empty($template)
+			|| ! is_readable(get_stylesheet_directory() . '/' . $template)
+		) {
+			return $current_template;
+		}
+		// made it here so we SHOULD be able to just locate the template and then return it.
+		return locate_template(array($template));
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -291,7 +291,7 @@ 
         add_filter('posts_fields', array($this, 'postsFields'));
         add_filter('posts_join', array($this, 'postsJoin'));
         add_filter(
-            'get_' . $this->post_type . '_metadata',
+            'get_'.$this->post_type.'_metadata',
             array($CPT_Strategy, 'get_EE_post_type_metadata'),
             1,
             4
@@ -342,7 +342,7 @@ 
     public function setRequestVarsIfCpt()
     {
         // check if ee action var has been set
-        if (! $this->request->is_set('ee')) {
+        if ( ! $this->request->is_set('ee')) {
             // check that route exists for CPT archive slug
             if (is_archive() && \EE_Config::get_route($this->cpt_details['plural_slug'])) {
                 // ie: set "ee" to "events"
@@ -367,7 +367,7 @@ 
     {
         // get CPT table data via CPT Model
         $model = \EE_Registry::instance()->load_model($model_name);
-        if (! $model instanceof \EEM_Base) {
+        if ( ! $model instanceof \EEM_Base) {
             throw new \EE_Error(
                 sprintf(
                     __(
@@ -381,10 +381,10 @@ 
         $this->setModel($model);
         $this->setModelTables($this->model->get_tables());
         // is there a Meta Table for this CPT?
-        if (isset($this->cpt_details['tables'][$model_name . '_Meta'])
-            && $this->cpt_details['tables'][$model_name . '_Meta'] instanceof \EE_Secondary_Table
+        if (isset($this->cpt_details['tables'][$model_name.'_Meta'])
+            && $this->cpt_details['tables'][$model_name.'_Meta'] instanceof \EE_Secondary_Table
         ) {
-            $this->setMetaTable($this->cpt_details['tables'][$model_name . '_Meta']);
+            $this->setMetaTable($this->cpt_details['tables'][$model_name.'_Meta']);
         }
     }
 
@@ -399,7 +399,7 @@ 
     protected function cptStrategyClass($model_name)
     {
         // creates classname like:  CPT_Event_Strategy
-        $CPT_Strategy_class_name = 'CPT_' . $model_name . '_Strategy';
+        $CPT_Strategy_class_name = 'CPT_'.$model_name.'_Strategy';
         // load and instantiate
         $CPT_Strategy = \EE_Registry::instance()->load_core(
             $CPT_Strategy_class_name,
@@ -427,7 +427,7 @@ 
         // does this CPT have a meta table ?
         if ($this->meta_table instanceof \EE_Secondary_Table) {
             // adds something like ", wp_esp_event_meta.* " to WP Query SELECT statement
-            $SQL .= ', ' . $this->meta_table->get_table_name() . '.* ';
+            $SQL .= ', '.$this->meta_table->get_table_name().'.* ';
         }
         remove_filter('posts_fields', array($this, 'postsFields'));
         return $SQL;
@@ -496,7 +496,7 @@ 
         global $post;
         // notice if the cpt is registered with `show_ee_ui` set to false, we take that to mean that the WordPress core ui
         // for interacting with the CPT is desired and there is no EE UI for interacting with the CPT in the admin.
-        if (! $post instanceof \WP_Post
+        if ( ! $post instanceof \WP_Post
             || $post->post_type !== $this->post_type
             || (
                 isset($this->cpt_details['args']['show_ee_ui'])
@@ -526,7 +526,7 @@ 
     public function addTemplateFilters()
     {
         // if requested cpt supports page_templates and it's the main query
-        if (! empty($this->cpt_details['args']['page_templates']) && $this->wp_query->is_main_query()) {
+        if ( ! empty($this->cpt_details['args']['page_templates']) && $this->wp_query->is_main_query()) {
             // then let's hook into the appropriate query_template hook
             add_filter('single_template', array($this, 'singleCptTemplate'));
         }
@@ -550,7 +550,7 @@ 
         // exit early if default or not set or invalid path (accounts for theme changes)
         if ($template === 'default'
             || empty($template)
-            || ! is_readable(get_stylesheet_directory() . '/' . $template)
+            || ! is_readable(get_stylesheet_directory().'/'.$template)
         ) {
             return $current_template;
         }