eventespresso / event-espresso-core

core/services/commands/registration/CopyRegistrationDetailsCommand.php

Indentation +44 added lines, -44 removed lines

@@ -16,48 +16,48 @@
 {
 
 
-    /**
-     * @var \EE_Registration $target_registration
-     */
-    private $target_registration;
-
-
-    /**
-     * @var \EE_Registration $registration_to_copy
-     */
-    private $registration_to_copy;
-
-
-    /**
-     * CopyRegistrationDetailsCommand constructor.
-     *
-     * @param \EE_Registration $target_registration
-     * @param \EE_Registration $registration_to_copy
-     * v
-     */
-    public function __construct(
-        \EE_Registration $target_registration,
-        \EE_Registration $registration_to_copy
-    ) {
-        $this->target_registration = $target_registration;
-        $this->registration_to_copy = $registration_to_copy;
-    }
-
-
-    /**
-     * @return \EE_Registration
-     */
-    public function targetRegistration()
-    {
-        return $this->target_registration;
-    }
-
-
-    /**
-     * @return \EE_Registration
-     */
-    public function registrationToCopy()
-    {
-        return $this->registration_to_copy;
-    }
+	/**
+	 * @var \EE_Registration $target_registration
+	 */
+	private $target_registration;
+
+
+	/**
+	 * @var \EE_Registration $registration_to_copy
+	 */
+	private $registration_to_copy;
+
+
+	/**
+	 * CopyRegistrationDetailsCommand constructor.
+	 *
+	 * @param \EE_Registration $target_registration
+	 * @param \EE_Registration $registration_to_copy
+	 * v
+	 */
+	public function __construct(
+		\EE_Registration $target_registration,
+		\EE_Registration $registration_to_copy
+	) {
+		$this->target_registration = $target_registration;
+		$this->registration_to_copy = $registration_to_copy;
+	}
+
+
+	/**
+	 * @return \EE_Registration
+	 */
+	public function targetRegistration()
+	{
+		return $this->target_registration;
+	}
+
+
+	/**
+	 * @return \EE_Registration
+	 */
+	public function registrationToCopy()
+	{
+		return $this->registration_to_copy;
+	}
 }

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(
-                    __('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 \EventEspresso\core\domain\services\capabilities\CapCheckInterface
-     * @throws \EventEspresso\core\exceptions\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(
+					__('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 \EventEspresso\core\domain\services\capabilities\CapCheckInterface
+	 * @throws \EventEspresso\core\exceptions\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;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -79,7 +79,7 @@ 
     ) {
         // grab the related ticket object for this line_item
         $this->ticket = $ticket_line_item->ticket();
-        if (! $this->ticket instanceof EE_Ticket) {
+        if ( ! $this->ticket instanceof EE_Ticket) {
             throw new InvalidEntityException(
                 is_object($this->ticket) ? get_class($this->ticket) : gettype($this->ticket),
                 'EE_Ticket',
@@ -103,7 +103,7 @@ 
      */
     public function getCapCheck()
     {
-        if (! $this->cap_check instanceof CapCheckInterface) {
+        if ( ! $this->cap_check instanceof CapCheckInterface) {
             return new CapCheck('ee_edit_registrations', 'create_new_registration');
         }
         return $this->cap_check;

core/services/commands/middleware/AddActionHook.php

Indentation +18 added lines, -18 removed lines

@@ -15,22 +15,22 @@
 class AddActionHook implements CommandBusMiddlewareInterface
 {
 
-    /**
-     * @param CommandInterface $command
-     * @param Closure          $next
-     * @return mixed
-     */
-    public function handle(CommandInterface $command, Closure $next)
-    {
-        do_action(
-            'AHEE__EventEspresso_core_services_commands_middleware_AddActionHook__handle__before',
-            $command
-        );
-        $results = $next($command);
-        do_action(
-            'AHEE__EventEspresso_core_services_commands_middleware_AddActionHook__handle__after',
-            $command
-        );
-        return $results;
-    }
+	/**
+	 * @param CommandInterface $command
+	 * @param Closure          $next
+	 * @return mixed
+	 */
+	public function handle(CommandInterface $command, Closure $next)
+	{
+		do_action(
+			'AHEE__EventEspresso_core_services_commands_middleware_AddActionHook__handle__before',
+			$command
+		);
+		$results = $next($command);
+		do_action(
+			'AHEE__EventEspresso_core_services_commands_middleware_AddActionHook__handle__after',
+			$command
+		);
+		return $results;
+	}
 }

core/services/commands/middleware/InvalidCommandBusMiddlewareException.php

Indentation +30 added lines, -30 removed lines

@@ -16,35 +16,35 @@
 {
 
 
-    /**
-     * @access public
-     * @param  mixed     $command_bus_middleware_object
-     * @param  string    $message
-     * @param int        $code
-     * @param \Exception $previous
-     */
-    public function __construct($command_bus_middleware_object, $message = '', $code = 0, \Exception $previous = null)
-    {
-        $command_bus_middleware = is_object($command_bus_middleware_object)
-            ? get_class($command_bus_middleware_object)
-            : gettype($command_bus_middleware_object);
+	/**
+	 * @access public
+	 * @param  mixed     $command_bus_middleware_object
+	 * @param  string    $message
+	 * @param int        $code
+	 * @param \Exception $previous
+	 */
+	public function __construct($command_bus_middleware_object, $message = '', $code = 0, \Exception $previous = null)
+	{
+		$command_bus_middleware = is_object($command_bus_middleware_object)
+			? get_class($command_bus_middleware_object)
+			: gettype($command_bus_middleware_object);
 
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    'The supplied Command Bus Middleware "%1$s" does not have a valid name. It should be in the following format: "{CommandName}Handler" ',
-                    'event_espresso'
-                ),
-                $command_bus_middleware
-            );
-        }
-        parent::__construct(
-            '$command_bus_middleware',
-            $command_bus_middleware,
-            'CommandBusMiddlewareInterface',
-            $message,
-            $code,
-            $previous
-        );
-    }
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'The supplied Command Bus Middleware "%1$s" does not have a valid name. It should be in the following format: "{CommandName}Handler" ',
+					'event_espresso'
+				),
+				$command_bus_middleware
+			);
+		}
+		parent::__construct(
+			'$command_bus_middleware',
+			$command_bus_middleware,
+			'CommandBusMiddlewareInterface',
+			$message,
+			$code,
+			$previous
+		);
+	}
 }

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/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/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/libraries/form_sections/form_handlers/FormHandler.php

Spacing +18 added lines, -18 removed lines

@@ -170,7 +170,7 @@ 
      */
     public function form($for_display = false)
     {
-        if (! $this->formIsValid()) {
+        if ( ! $this->formIsValid()) {
             return null;
         }
         if ($for_display) {
@@ -272,7 +272,7 @@ 
      */
     public function setFormName($form_name)
     {
-        if (! is_string($form_name)) {
+        if ( ! is_string($form_name)) {
             throw new InvalidDataTypeException('$form_name', $form_name, 'string');
         }
         $this->form_name = $form_name;
@@ -296,7 +296,7 @@ 
      */
     public function setAdminName($admin_name)
     {
-        if (! is_string($admin_name)) {
+        if ( ! is_string($admin_name)) {
             throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
         }
         $this->admin_name = $admin_name;
@@ -320,7 +320,7 @@ 
      */
     public function setSlug($slug)
     {
-        if (! is_string($slug)) {
+        if ( ! is_string($slug)) {
             throw new InvalidDataTypeException('$slug', $slug, 'string');
         }
         $this->slug = $slug;
@@ -343,7 +343,7 @@ 
      */
     public function setSubmitBtnText($submit_btn_text)
     {
-        if (! is_string($submit_btn_text)) {
+        if ( ! is_string($submit_btn_text)) {
             throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
         }
         if (empty($submit_btn_text)) {
@@ -372,7 +372,7 @@ 
      */
     public function setFormAction($form_action)
     {
-        if (! is_string($form_action)) {
+        if ( ! is_string($form_action)) {
             throw new InvalidDataTypeException('$form_action', $form_action, 'string');
         }
         $this->form_action = $form_action;
@@ -417,7 +417,7 @@ 
      */
     public function setFormConfig($form_config)
     {
-        if (! in_array(
+        if ( ! in_array(
             $form_config,
             array(
                 FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
@@ -490,11 +490,11 @@ 
         $text = ! empty($text) ? $text : $this->submitBtnText();
         return new EE_Submit_Input(
             array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(),
-                'html_id'               => 'ee-form-submit-' . $this->slug(),
+                'html_name'             => 'ee-form-submit-'.$this->slug(),
+                'html_id'               => 'ee-form-submit-'.$this->slug(),
                 'html_class'            => 'ee-form-submit',
                 'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
+                'other_html_attributes' => ' rel="'.$this->slug().'"',
                 'default'               => $text,
             )
         );
@@ -510,11 +510,11 @@ 
      */
     public function appendSubmitButton($text = '')
     {
-        if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
+        if ($this->form->subsection_exists($this->slug().'-submit-btn')) {
             return;
         }
         $this->form->add_subsections(
-            array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
+            array($this->slug().'-submit-btn' => $this->generateSubmitButton($text)),
             null,
             false
         );
@@ -531,11 +531,11 @@ 
     {
         $cancel_button = new EE_Submit_Input(
             array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
-                'html_id'               => 'ee-cancel-form-' . $this->slug(),
+                'html_name'             => 'ee-form-submit-'.$this->slug(), // YES! Same name as submit !!!
+                'html_id'               => 'ee-cancel-form-'.$this->slug(),
                 'html_class'            => 'ee-cancel-form',
                 'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
+                'other_html_attributes' => ' rel="'.$this->slug().'"',
                 'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
             )
         );
@@ -555,7 +555,7 @@ 
         $this->form->add_subsections(
             array(
                 'clear-submit-btn-float' => new EE_Form_Section_HTML(
-                    EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
+                    EEH_HTML::div('', '', 'clear-float').EEH_HTML::divx()
                 ),
             ),
             null,
@@ -616,11 +616,11 @@ 
      */
     public function process($submitted_form_data = array())
     {
-        if (! $this->form()->was_submitted($submitted_form_data)) {
+        if ( ! $this->form()->was_submitted($submitted_form_data)) {
             throw new InvalidFormSubmissionException($this->form_name);
         }
         $this->form(true)->receive_form_submission($submitted_form_data);
-        if (! $this->form()->is_valid()) {
+        if ( ! $this->form()->is_valid()) {
             throw new InvalidFormSubmissionException(
                 $this->form_name,
                 sprintf(

Indentation +635 added lines, -635 removed lines

@@ -29,639 +29,639 @@
 abstract class FormHandler implements FormHandlerInterface
 {
 
-    /**
-     * will add opening and closing HTML form tags as well as a submit button
-     */
-    const ADD_FORM_TAGS_AND_SUBMIT = 'add_form_tags_and_submit';
-
-    /**
-     * will add opening and closing HTML form tags but NOT a submit button
-     */
-    const ADD_FORM_TAGS_ONLY = 'add_form_tags_only';
-
-    /**
-     * will NOT add opening and closing HTML form tags but will add a submit button
-     */
-    const ADD_FORM_SUBMIT_ONLY = 'add_form_submit_only';
-
-    /**
-     * will NOT add opening and closing HTML form tags NOR a submit button
-     */
-    const DO_NOT_SETUP_FORM = 'do_not_setup_form';
-
-    /**
-     * if set to false, then this form has no displayable content,
-     * and will only be used for processing data sent passed via GET or POST
-     * defaults to true ( ie: form has displayable content )
-     *
-     * @var boolean $displayable
-     */
-    private $displayable = true;
-
-    /**
-     * @var string $form_name
-     */
-    private $form_name;
-
-    /**
-     * @var string $admin_name
-     */
-    private $admin_name;
-
-    /**
-     * @var string $slug
-     */
-    private $slug;
-
-    /**
-     * @var string $submit_btn_text
-     */
-    private $submit_btn_text;
-
-    /**
-     * @var string $form_action
-     */
-    private $form_action;
-
-    /**
-     * form params in key value pairs
-     * can be added to form action URL or as hidden inputs
-     *
-     * @var array $form_args
-     */
-    private $form_args = array();
-
-    /**
-     * value of one of the string constant above
-     *
-     * @var string $form_config
-     */
-    private $form_config;
-
-    /**
-     * whether or not the form was determined to be invalid
-     *
-     * @var boolean $form_has_errors
-     */
-    private $form_has_errors;
-
-    /**
-     * the absolute top level form section being used on the page
-     *
-     * @var EE_Form_Section_Proper $form
-     */
-    private $form;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    protected $registry;
-
-    // phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
-    /**
-     * Form constructor.
-     *
-     * @param string      $form_name
-     * @param string      $admin_name
-     * @param string      $slug
-     * @param string      $form_action
-     * @param string      $form_config
-     * @param EE_Registry $registry
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        $form_name,
-        $admin_name,
-        $slug,
-        $form_action = '',
-        $form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-        EE_Registry $registry
-    ) {
-        $this->setFormName($form_name);
-        $this->setAdminName($admin_name);
-        $this->setSlug($slug);
-        $this->setFormAction($form_action);
-        $this->setFormConfig($form_config);
-        $this->setSubmitBtnText(esc_html__('Submit', 'event_espresso'));
-        $this->registry = $registry;
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function getFormConfigConstants()
-    {
-        return array(
-            FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-            FormHandler::ADD_FORM_TAGS_ONLY,
-            FormHandler::ADD_FORM_SUBMIT_ONLY,
-            FormHandler::DO_NOT_SETUP_FORM,
-        );
-    }
-
-
-    /**
-     * @param bool $for_display
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws LogicException
-     */
-    public function form($for_display = false)
-    {
-        if (! $this->formIsValid()) {
-            return null;
-        }
-        if ($for_display) {
-            $form_config = $this->formConfig();
-            if ($form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-                || $form_config === FormHandler::ADD_FORM_SUBMIT_ONLY
-            ) {
-                $this->appendSubmitButton();
-                $this->clearFormButtonFloats();
-            }
-        }
-        return $this->form;
-    }
-
-
-    /**
-     * @return boolean
-     * @throws LogicException
-     */
-    public function formIsValid()
-    {
-        if ($this->form instanceof EE_Form_Section_Proper) {
-            return true;
-        }
-        $form = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__formIsValid__generated_form_object',
-            $this->generate(),
-            $this
-        );
-        if ($this->verifyForm($form)) {
-            $this->setForm($form);
-        }
-        return true;
-    }
-
-
-    /**
-     * @param EE_Form_Section_Proper|null $form
-     * @return bool
-     * @throws LogicException
-     */
-    public function verifyForm(EE_Form_Section_Proper $form = null)
-    {
-        $form = $form !== null ? $form : $this->form;
-        if ($form instanceof EE_Form_Section_Proper) {
-            return true;
-        }
-        throw new LogicException(
-            sprintf(
-                esc_html__('The "%1$s" form is invalid or missing. %2$s', 'event_espresso'),
-                $this->form_name,
-                var_export($form, true)
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Form_Section_Proper $form
-     */
-    public function setForm(EE_Form_Section_Proper $form)
-    {
-        $this->form = $form;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function displayable()
-    {
-        return $this->displayable;
-    }
-
-
-    /**
-     * @param boolean $displayable
-     */
-    public function setDisplayable($displayable = false)
-    {
-        $this->displayable = filter_var($displayable, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * a public name for the form that can be displayed on the frontend of a site
-     *
-     * @return string
-     */
-    public function formName()
-    {
-        return $this->form_name;
-    }
-
-
-    /**
-     * @param string $form_name
-     * @throws InvalidDataTypeException
-     */
-    public function setFormName($form_name)
-    {
-        if (! is_string($form_name)) {
-            throw new InvalidDataTypeException('$form_name', $form_name, 'string');
-        }
-        $this->form_name = $form_name;
-    }
-
-
-    /**
-     * a public name for the form that can be displayed, but only in the admin
-     *
-     * @return string
-     */
-    public function adminName()
-    {
-        return $this->admin_name;
-    }
-
-
-    /**
-     * @param string $admin_name
-     * @throws InvalidDataTypeException
-     */
-    public function setAdminName($admin_name)
-    {
-        if (! is_string($admin_name)) {
-            throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
-        }
-        $this->admin_name = $admin_name;
-    }
-
-
-    /**
-     * a URL friendly string that can be used for identifying the form
-     *
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->slug;
-    }
-
-
-    /**
-     * @param string $slug
-     * @throws InvalidDataTypeException
-     */
-    public function setSlug($slug)
-    {
-        if (! is_string($slug)) {
-            throw new InvalidDataTypeException('$slug', $slug, 'string');
-        }
-        $this->slug = $slug;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function submitBtnText()
-    {
-        return $this->submit_btn_text;
-    }
-
-
-    /**
-     * @param string $submit_btn_text
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function setSubmitBtnText($submit_btn_text)
-    {
-        if (! is_string($submit_btn_text)) {
-            throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
-        }
-        if (empty($submit_btn_text)) {
-            throw new InvalidArgumentException(
-                esc_html__('Can not set Submit button text because an empty string was provided.', 'event_espresso')
-            );
-        }
-        $this->submit_btn_text = $submit_btn_text;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function formAction()
-    {
-        return ! empty($this->form_args)
-            ? add_query_arg($this->form_args, $this->form_action)
-            : $this->form_action;
-    }
-
-
-    /**
-     * @param string $form_action
-     * @throws InvalidDataTypeException
-     */
-    public function setFormAction($form_action)
-    {
-        if (! is_string($form_action)) {
-            throw new InvalidDataTypeException('$form_action', $form_action, 'string');
-        }
-        $this->form_action = $form_action;
-    }
-
-
-    /**
-     * @param array $form_args
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function addFormActionArgs($form_args = array())
-    {
-        if (is_object($form_args)) {
-            throw new InvalidDataTypeException(
-                '$form_args',
-                $form_args,
-                'anything other than an object was expected.'
-            );
-        }
-        if (empty($form_args)) {
-            throw new InvalidArgumentException(
-                esc_html__('The redirect arguments can not be an empty array.', 'event_espresso')
-            );
-        }
-        $this->form_args = array_merge($this->form_args, $form_args);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function formConfig()
-    {
-        return $this->form_config;
-    }
-
-
-    /**
-     * @param string $form_config
-     * @throws DomainException
-     */
-    public function setFormConfig($form_config)
-    {
-        if (! in_array(
-            $form_config,
-            array(
-                FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-                FormHandler::ADD_FORM_TAGS_ONLY,
-                FormHandler::ADD_FORM_SUBMIT_ONLY,
-                FormHandler::DO_NOT_SETUP_FORM,
-            ),
-            true
-        )
-        ) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        '"%1$s" is not a valid value for the form config. Please use one of the class constants on \EventEspresso\core\libraries\form_sections\form_handlers\Form',
-                        'event_espresso'
-                    ),
-                    $form_config
-                )
-            );
-        }
-        $this->form_config = $form_config;
-    }
-
-
-    /**
-     * called after the form is instantiated
-     * and used for performing any logic that needs to occur early
-     * before any of the other methods are called.
-     * returns true if everything is ok to proceed,
-     * and false if no further form logic should be implemented
-     *
-     * @return boolean
-     */
-    public function initialize()
-    {
-        $this->form_has_errors = EE_Error::has_error(true);
-        return true;
-    }
-
-
-    /**
-     * used for setting up css and js
-     *
-     * @return void
-     * @throws LogicException
-     * @throws EE_Error
-     */
-    public function enqueueStylesAndScripts()
-    {
-        $this->form()->enqueue_js();
-    }
-
-
-    /**
-     * creates and returns the actual form
-     *
-     * @return EE_Form_Section_Proper
-     */
-    abstract public function generate();
-
-
-    /**
-     * creates and returns an EE_Submit_Input labeled "Submit"
-     *
-     * @param string $text
-     * @return EE_Submit_Input
-     */
-    public function generateSubmitButton($text = '')
-    {
-        $text = ! empty($text) ? $text : $this->submitBtnText();
-        return new EE_Submit_Input(
-            array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(),
-                'html_id'               => 'ee-form-submit-' . $this->slug(),
-                'html_class'            => 'ee-form-submit',
-                'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => $text,
-            )
-        );
-    }
-
-
-    /**
-     * calls generateSubmitButton() and appends it onto the form along with a float clearing div
-     *
-     * @param string $text
-     * @return void
-     * @throws EE_Error
-     */
-    public function appendSubmitButton($text = '')
-    {
-        if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
-            return;
-        }
-        $this->form->add_subsections(
-            array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
-            null,
-            false
-        );
-    }
-
-
-    /**
-     * creates and returns an EE_Submit_Input labeled "Cancel"
-     *
-     * @param string $text
-     * @return EE_Submit_Input
-     */
-    public function generateCancelButton($text = '')
-    {
-        $cancel_button = new EE_Submit_Input(
-            array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
-                'html_id'               => 'ee-cancel-form-' . $this->slug(),
-                'html_class'            => 'ee-cancel-form',
-                'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
-            )
-        );
-        $cancel_button->set_button_css_attributes(false);
-        return $cancel_button;
-    }
-
-
-    /**
-     * appends a float clearing div onto end of form
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function clearFormButtonFloats()
-    {
-        $this->form->add_subsections(
-            array(
-                'clear-submit-btn-float' => new EE_Form_Section_HTML(
-                    EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
-                ),
-            ),
-            null,
-            false
-        );
-    }
-
-
-    /**
-     * takes the generated form and displays it along with ony other non-form HTML that may be required
-     * returns a string of HTML that can be directly echoed in a template
-     *
-     * @return string
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws LogicException
-     * @throws EE_Error
-     */
-    public function display()
-    {
-        $form_html = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__before_form',
-            ''
-        );
-        $form_config = $this->formConfig();
-        if ($form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-            || $form_config === FormHandler::ADD_FORM_TAGS_ONLY
-        ) {
-            $additional_props = $this->requiresMultipartEnctype()
-                ? 'enctype="multipart/form-data"'
-                : '';
-            $form_html .= $this->form()->form_open(
-                $this->formAction(),
-                'POST',
-                $additional_props
-            );
-        }
-        $form_html .= $this->form(true)->get_html();
-        if ($form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-            || $form_config === FormHandler::ADD_FORM_TAGS_ONLY
-        ) {
-            $form_html .= $this->form()->form_close();
-        }
-        $form_html .= apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__after_form',
-            ''
-        );
-        return $form_html;
-    }
-
-    /**
-     * Determines if this form needs "enctype='multipart/form-data'" or not.
-     * @since 4.9.80.p
-     * @return bool
-     * @throws EE_Error
-     */
-    public function requiresMultipartEnctype()
-    {
-        foreach ($this->form()->inputs_in_subsections() as $input) {
-            if ($input instanceof EE_File_Input) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * handles processing the form submission
-     * returns true or false depending on whether the form was processed successfully or not
-     *
-     * @param array $submitted_form_data
-     * @return array
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws EE_Error
-     * @throws LogicException
-     * @throws InvalidFormSubmissionException
-     */
-    public function process($submitted_form_data = array())
-    {
-        if (! $this->form()->was_submitted($submitted_form_data)) {
-            throw new InvalidFormSubmissionException($this->form_name);
-        }
-        $this->form(true)->receive_form_submission($submitted_form_data);
-        if (! $this->form()->is_valid()) {
-            throw new InvalidFormSubmissionException(
-                $this->form_name,
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" form is invalid. Please correct the following errors and resubmit: %2$s %3$s',
-                        'event_espresso'
-                    ),
-                    $this->form_name,
-                    '<br />',
-                    implode('<br />', $this->form()->get_validation_errors_accumulated())
-                )
-            );
-        }
-        return apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__process__valid_data',
-            $this->form()->valid_data(),
-            $this
-        );
-    }
+	/**
+	 * will add opening and closing HTML form tags as well as a submit button
+	 */
+	const ADD_FORM_TAGS_AND_SUBMIT = 'add_form_tags_and_submit';
+
+	/**
+	 * will add opening and closing HTML form tags but NOT a submit button
+	 */
+	const ADD_FORM_TAGS_ONLY = 'add_form_tags_only';
+
+	/**
+	 * will NOT add opening and closing HTML form tags but will add a submit button
+	 */
+	const ADD_FORM_SUBMIT_ONLY = 'add_form_submit_only';
+
+	/**
+	 * will NOT add opening and closing HTML form tags NOR a submit button
+	 */
+	const DO_NOT_SETUP_FORM = 'do_not_setup_form';
+
+	/**
+	 * if set to false, then this form has no displayable content,
+	 * and will only be used for processing data sent passed via GET or POST
+	 * defaults to true ( ie: form has displayable content )
+	 *
+	 * @var boolean $displayable
+	 */
+	private $displayable = true;
+
+	/**
+	 * @var string $form_name
+	 */
+	private $form_name;
+
+	/**
+	 * @var string $admin_name
+	 */
+	private $admin_name;
+
+	/**
+	 * @var string $slug
+	 */
+	private $slug;
+
+	/**
+	 * @var string $submit_btn_text
+	 */
+	private $submit_btn_text;
+
+	/**
+	 * @var string $form_action
+	 */
+	private $form_action;
+
+	/**
+	 * form params in key value pairs
+	 * can be added to form action URL or as hidden inputs
+	 *
+	 * @var array $form_args
+	 */
+	private $form_args = array();
+
+	/**
+	 * value of one of the string constant above
+	 *
+	 * @var string $form_config
+	 */
+	private $form_config;
+
+	/**
+	 * whether or not the form was determined to be invalid
+	 *
+	 * @var boolean $form_has_errors
+	 */
+	private $form_has_errors;
+
+	/**
+	 * the absolute top level form section being used on the page
+	 *
+	 * @var EE_Form_Section_Proper $form
+	 */
+	private $form;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	protected $registry;
+
+	// phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
+	/**
+	 * Form constructor.
+	 *
+	 * @param string      $form_name
+	 * @param string      $admin_name
+	 * @param string      $slug
+	 * @param string      $form_action
+	 * @param string      $form_config
+	 * @param EE_Registry $registry
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(
+		$form_name,
+		$admin_name,
+		$slug,
+		$form_action = '',
+		$form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+		EE_Registry $registry
+	) {
+		$this->setFormName($form_name);
+		$this->setAdminName($admin_name);
+		$this->setSlug($slug);
+		$this->setFormAction($form_action);
+		$this->setFormConfig($form_config);
+		$this->setSubmitBtnText(esc_html__('Submit', 'event_espresso'));
+		$this->registry = $registry;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function getFormConfigConstants()
+	{
+		return array(
+			FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+			FormHandler::ADD_FORM_TAGS_ONLY,
+			FormHandler::ADD_FORM_SUBMIT_ONLY,
+			FormHandler::DO_NOT_SETUP_FORM,
+		);
+	}
+
+
+	/**
+	 * @param bool $for_display
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws LogicException
+	 */
+	public function form($for_display = false)
+	{
+		if (! $this->formIsValid()) {
+			return null;
+		}
+		if ($for_display) {
+			$form_config = $this->formConfig();
+			if ($form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+				|| $form_config === FormHandler::ADD_FORM_SUBMIT_ONLY
+			) {
+				$this->appendSubmitButton();
+				$this->clearFormButtonFloats();
+			}
+		}
+		return $this->form;
+	}
+
+
+	/**
+	 * @return boolean
+	 * @throws LogicException
+	 */
+	public function formIsValid()
+	{
+		if ($this->form instanceof EE_Form_Section_Proper) {
+			return true;
+		}
+		$form = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__formIsValid__generated_form_object',
+			$this->generate(),
+			$this
+		);
+		if ($this->verifyForm($form)) {
+			$this->setForm($form);
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param EE_Form_Section_Proper|null $form
+	 * @return bool
+	 * @throws LogicException
+	 */
+	public function verifyForm(EE_Form_Section_Proper $form = null)
+	{
+		$form = $form !== null ? $form : $this->form;
+		if ($form instanceof EE_Form_Section_Proper) {
+			return true;
+		}
+		throw new LogicException(
+			sprintf(
+				esc_html__('The "%1$s" form is invalid or missing. %2$s', 'event_espresso'),
+				$this->form_name,
+				var_export($form, true)
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Form_Section_Proper $form
+	 */
+	public function setForm(EE_Form_Section_Proper $form)
+	{
+		$this->form = $form;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function displayable()
+	{
+		return $this->displayable;
+	}
+
+
+	/**
+	 * @param boolean $displayable
+	 */
+	public function setDisplayable($displayable = false)
+	{
+		$this->displayable = filter_var($displayable, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * a public name for the form that can be displayed on the frontend of a site
+	 *
+	 * @return string
+	 */
+	public function formName()
+	{
+		return $this->form_name;
+	}
+
+
+	/**
+	 * @param string $form_name
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormName($form_name)
+	{
+		if (! is_string($form_name)) {
+			throw new InvalidDataTypeException('$form_name', $form_name, 'string');
+		}
+		$this->form_name = $form_name;
+	}
+
+
+	/**
+	 * a public name for the form that can be displayed, but only in the admin
+	 *
+	 * @return string
+	 */
+	public function adminName()
+	{
+		return $this->admin_name;
+	}
+
+
+	/**
+	 * @param string $admin_name
+	 * @throws InvalidDataTypeException
+	 */
+	public function setAdminName($admin_name)
+	{
+		if (! is_string($admin_name)) {
+			throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
+		}
+		$this->admin_name = $admin_name;
+	}
+
+
+	/**
+	 * a URL friendly string that can be used for identifying the form
+	 *
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->slug;
+	}
+
+
+	/**
+	 * @param string $slug
+	 * @throws InvalidDataTypeException
+	 */
+	public function setSlug($slug)
+	{
+		if (! is_string($slug)) {
+			throw new InvalidDataTypeException('$slug', $slug, 'string');
+		}
+		$this->slug = $slug;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function submitBtnText()
+	{
+		return $this->submit_btn_text;
+	}
+
+
+	/**
+	 * @param string $submit_btn_text
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function setSubmitBtnText($submit_btn_text)
+	{
+		if (! is_string($submit_btn_text)) {
+			throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
+		}
+		if (empty($submit_btn_text)) {
+			throw new InvalidArgumentException(
+				esc_html__('Can not set Submit button text because an empty string was provided.', 'event_espresso')
+			);
+		}
+		$this->submit_btn_text = $submit_btn_text;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function formAction()
+	{
+		return ! empty($this->form_args)
+			? add_query_arg($this->form_args, $this->form_action)
+			: $this->form_action;
+	}
+
+
+	/**
+	 * @param string $form_action
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormAction($form_action)
+	{
+		if (! is_string($form_action)) {
+			throw new InvalidDataTypeException('$form_action', $form_action, 'string');
+		}
+		$this->form_action = $form_action;
+	}
+
+
+	/**
+	 * @param array $form_args
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function addFormActionArgs($form_args = array())
+	{
+		if (is_object($form_args)) {
+			throw new InvalidDataTypeException(
+				'$form_args',
+				$form_args,
+				'anything other than an object was expected.'
+			);
+		}
+		if (empty($form_args)) {
+			throw new InvalidArgumentException(
+				esc_html__('The redirect arguments can not be an empty array.', 'event_espresso')
+			);
+		}
+		$this->form_args = array_merge($this->form_args, $form_args);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function formConfig()
+	{
+		return $this->form_config;
+	}
+
+
+	/**
+	 * @param string $form_config
+	 * @throws DomainException
+	 */
+	public function setFormConfig($form_config)
+	{
+		if (! in_array(
+			$form_config,
+			array(
+				FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+				FormHandler::ADD_FORM_TAGS_ONLY,
+				FormHandler::ADD_FORM_SUBMIT_ONLY,
+				FormHandler::DO_NOT_SETUP_FORM,
+			),
+			true
+		)
+		) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'"%1$s" is not a valid value for the form config. Please use one of the class constants on \EventEspresso\core\libraries\form_sections\form_handlers\Form',
+						'event_espresso'
+					),
+					$form_config
+				)
+			);
+		}
+		$this->form_config = $form_config;
+	}
+
+
+	/**
+	 * called after the form is instantiated
+	 * and used for performing any logic that needs to occur early
+	 * before any of the other methods are called.
+	 * returns true if everything is ok to proceed,
+	 * and false if no further form logic should be implemented
+	 *
+	 * @return boolean
+	 */
+	public function initialize()
+	{
+		$this->form_has_errors = EE_Error::has_error(true);
+		return true;
+	}
+
+
+	/**
+	 * used for setting up css and js
+	 *
+	 * @return void
+	 * @throws LogicException
+	 * @throws EE_Error
+	 */
+	public function enqueueStylesAndScripts()
+	{
+		$this->form()->enqueue_js();
+	}
+
+
+	/**
+	 * creates and returns the actual form
+	 *
+	 * @return EE_Form_Section_Proper
+	 */
+	abstract public function generate();
+
+
+	/**
+	 * creates and returns an EE_Submit_Input labeled "Submit"
+	 *
+	 * @param string $text
+	 * @return EE_Submit_Input
+	 */
+	public function generateSubmitButton($text = '')
+	{
+		$text = ! empty($text) ? $text : $this->submitBtnText();
+		return new EE_Submit_Input(
+			array(
+				'html_name'             => 'ee-form-submit-' . $this->slug(),
+				'html_id'               => 'ee-form-submit-' . $this->slug(),
+				'html_class'            => 'ee-form-submit',
+				'html_label'            => '&nbsp;',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => $text,
+			)
+		);
+	}
+
+
+	/**
+	 * calls generateSubmitButton() and appends it onto the form along with a float clearing div
+	 *
+	 * @param string $text
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function appendSubmitButton($text = '')
+	{
+		if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
+			return;
+		}
+		$this->form->add_subsections(
+			array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
+			null,
+			false
+		);
+	}
+
+
+	/**
+	 * creates and returns an EE_Submit_Input labeled "Cancel"
+	 *
+	 * @param string $text
+	 * @return EE_Submit_Input
+	 */
+	public function generateCancelButton($text = '')
+	{
+		$cancel_button = new EE_Submit_Input(
+			array(
+				'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
+				'html_id'               => 'ee-cancel-form-' . $this->slug(),
+				'html_class'            => 'ee-cancel-form',
+				'html_label'            => '&nbsp;',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
+			)
+		);
+		$cancel_button->set_button_css_attributes(false);
+		return $cancel_button;
+	}
+
+
+	/**
+	 * appends a float clearing div onto end of form
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function clearFormButtonFloats()
+	{
+		$this->form->add_subsections(
+			array(
+				'clear-submit-btn-float' => new EE_Form_Section_HTML(
+					EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
+				),
+			),
+			null,
+			false
+		);
+	}
+
+
+	/**
+	 * takes the generated form and displays it along with ony other non-form HTML that may be required
+	 * returns a string of HTML that can be directly echoed in a template
+	 *
+	 * @return string
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws LogicException
+	 * @throws EE_Error
+	 */
+	public function display()
+	{
+		$form_html = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__before_form',
+			''
+		);
+		$form_config = $this->formConfig();
+		if ($form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+			|| $form_config === FormHandler::ADD_FORM_TAGS_ONLY
+		) {
+			$additional_props = $this->requiresMultipartEnctype()
+				? 'enctype="multipart/form-data"'
+				: '';
+			$form_html .= $this->form()->form_open(
+				$this->formAction(),
+				'POST',
+				$additional_props
+			);
+		}
+		$form_html .= $this->form(true)->get_html();
+		if ($form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+			|| $form_config === FormHandler::ADD_FORM_TAGS_ONLY
+		) {
+			$form_html .= $this->form()->form_close();
+		}
+		$form_html .= apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__after_form',
+			''
+		);
+		return $form_html;
+	}
+
+	/**
+	 * Determines if this form needs "enctype='multipart/form-data'" or not.
+	 * @since 4.9.80.p
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function requiresMultipartEnctype()
+	{
+		foreach ($this->form()->inputs_in_subsections() as $input) {
+			if ($input instanceof EE_File_Input) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * handles processing the form submission
+	 * returns true or false depending on whether the form was processed successfully or not
+	 *
+	 * @param array $submitted_form_data
+	 * @return array
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws LogicException
+	 * @throws InvalidFormSubmissionException
+	 */
+	public function process($submitted_form_data = array())
+	{
+		if (! $this->form()->was_submitted($submitted_form_data)) {
+			throw new InvalidFormSubmissionException($this->form_name);
+		}
+		$this->form(true)->receive_form_submission($submitted_form_data);
+		if (! $this->form()->is_valid()) {
+			throw new InvalidFormSubmissionException(
+				$this->form_name,
+				sprintf(
+					esc_html__(
+						'The "%1$s" form is invalid. Please correct the following errors and resubmit: %2$s %3$s',
+						'event_espresso'
+					),
+					$this->form_name,
+					'<br />',
+					implode('<br />', $this->form()->get_validation_errors_accumulated())
+				)
+			);
+		}
+		return apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__process__valid_data',
+			$this->form()->valid_data(),
+			$this
+		);
+	}
 }

core/libraries/form_sections/form_handlers/InvalidFormHandlerException.php

Indentation +21 added lines, -21 removed lines

@@ -13,25 +13,25 @@
 class InvalidFormHandlerException extends \UnexpectedValueException
 {
 
-    /**
-     * InvalidFormHandlerException constructor.
-     *
-     * @param string     $actual the FormHandler object that was received
-     * @param string     $message
-     * @param int        $code
-     * @param \Exception $previous
-     */
-    public function __construct($actual, $message = '', $code = 0, \Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    'A valid Form Handler was expected but instead "%1$s" was received.',
-                    'event_espresso'
-                ),
-                $actual
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidFormHandlerException constructor.
+	 *
+	 * @param string     $actual the FormHandler object that was received
+	 * @param string     $message
+	 * @param int        $code
+	 * @param \Exception $previous
+	 */
+	public function __construct($actual, $message = '', $code = 0, \Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'A valid Form Handler was expected but instead "%1$s" was received.',
+					'event_espresso'
+				),
+				$actual
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }