eventespresso / event-espresso-core

core/services/graphql/types/TypeBase.php

Indentation +263 added lines, -263 removed lines

@@ -37,267 +37,267 @@
  */
 abstract class TypeBase implements TypeInterface
 {
-    /**
-     * The graphql namespace/prefix.
-     */
-    protected string $namespace   = 'Espresso';
-
-    protected ?EEM_Base $model       = null;
-
-    protected string $name        = '';
-
-    protected string $description = '';
-
-    /**
-     * @var GraphQLFieldInterface[] $fields
-     */
-    protected array $fields              = [];
-
-    /**
-     * @var GraphQLInterfaceInterface[] $interfaces
-     */
-    protected array $interfaces          = [];
-
-    protected FieldResolver $field_resolver;
-
-    protected bool $is_custom_post_type = false;
-
-
-    /**
-     * TypeBase constructor.
-     *
-     * @param EEM_Base|null $model
-     */
-    public function __construct(EEM_Base $model = null)
-    {
-        $this->model = $model;
-        $this->setFields($this->getFields());
-        $this->field_resolver = new FieldResolver(
-            $this->model,
-            $this->getFieldsForResolver()
-        );
-    }
-
-
-    /**
-     * @return GraphQLFieldInterface[]
-     * @since 5.0.0.p
-     */
-    abstract protected function getFields(): array;
-
-
-    /**
-     * @return string
-     */
-    public function name(): string
-    {
-        return $this->name;
-    }
-
-
-    /**
-     * @param string $name
-     */
-    protected function setName(string $name)
-    {
-        $this->name = $name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function description(): string
-    {
-        return $this->description;
-    }
-
-
-    /**
-     * @param string $description
-     */
-    protected function setDescription(string $description)
-    {
-        $this->description = $description;
-    }
-
-
-    /**
-     * @return GraphQLFieldInterface[]
-     * @since 5.0.0.p
-     */
-    public function fields(): array
-    {
-        return $this->fields;
-    }
-
-
-    /**
-     * @param GraphQLFieldInterface[] $fields
-     */
-    protected function setFields(array $fields)
-    {
-        foreach ($fields as $field) {
-            if ($field instanceof GraphQLField) {
-                $this->fields[] = $field;
-            }
-        }
-    }
-
-
-    /**
-     * Creates a key map for internal resolver.
-     *
-     * @return array
-     * @since 5.0.0.p
-     */
-    public function getFieldsForResolver(): array
-    {
-        $fields = [];
-        foreach ($this->fields() as $field) {
-            if ($field->useForOutput()) {
-                $fields[ $field->name() ] = $field;
-            }
-        }
-        return $fields;
-    }
-
-
-    public function interfaces(): array
-    {
-        return $this->interfaces;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCustomPostType(): bool
-    {
-        return $this->is_custom_post_type;
-    }
-
-
-    /**
-     * @param bool $is_custom_post_type
-     */
-    protected function setIsCustomPostType(bool $is_custom_post_type)
-    {
-        $this->is_custom_post_type = filter_var($is_custom_post_type, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @param int|float $value
-     * @return int
-     * @since 5.0.0.p
-     */
-    public function parseInfiniteValue($value): int
-    {
-        $value = trim((string) $value);
-        return $value === ''
-               || $value === '∞'
-               || $value === 'INF'
-               || $value === INF
-               || $value === EE_INF
-               || is_infinite((float) $value)
-            ? -1
-            : $value;
-    }
-
-
-    /**
-     * @param mixed $source
-     * @return EE_Base_Class|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function getModel($source): ?EE_Base_Class
-    {
-        // If it comes from a custom connection
-        // where the $source is already instantiated.
-        if ($source instanceof EE_Base_Class) {
-            return $source;
-        }
-        return $source instanceof Post
-            ? $this->model->get_one_by_ID($source->ID)
-            : null;
-    }
-
-
-    /**
-     * @param mixed       $source  The source that's passed down the GraphQL queries
-     * @param array       $args    The inputArgs on the field
-     * @param AppContext  $context The AppContext passed down the GraphQL tree
-     * @param ResolveInfo $info    The ResolveInfo passed down the GraphQL tree
-     * @return EE_Base_Class|Deferred|string|null
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws UnexpectedEntityException
-     * @throws UserError
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 5.0.0.p
-     */
-    public function resolveField($source, array $args, AppContext $context, ResolveInfo $info)
-    {
-        $source = $source instanceof RootQuery
-            ? $source
-            : $this->getModel($source);
-
-        return $this->field_resolver->resolve($source, $args, $context, $info);
-    }
-
-
-    /**
-     * @param mixed      $payload The payload returned after mutation
-     * @param array      $args    The inputArgs on the field
-     * @param AppContext $context The AppContext passed down the GraphQL tree
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function resolveFromPayload($payload, array $args, AppContext $context)
-    {
-        if (empty($payload['id'])) {
-            return null;
-        }
-        return $this->model->get_one_by_ID($payload['id']);
-    }
-
-
-    /**
-     * Prepares a datetime value in ISO8601/RFC3339 format.
-     * It is assumed that the value of $datetime is in the format
-     * returned by EE_Base_Class::get_format().
-     *
-     * @param string        $datetime The datetime value.
-     * @param EE_Base_Class $source   The source object.
-     * @return string ISO8601/RFC3339 formatted datetime.
-     * @throws Exception
-     */
-    public function formatDatetime(string $datetime, EE_Base_Class $source): string
-    {
-        $format = $source->get_format();
-        // create date object based on local timezone
-        $datetime = DateTime::createFromFormat($format, $datetime, new DateTimeZone($source->get_timezone()));
-        // change the timezone to UTC
-        $datetime->setTimezone(new DateTimeZone('UTC'));
-
-        return $datetime->format(DateTimeInterface::RFC3339);
-    }
-
-
-    /**
-     * Converts an object to JSON. The object must have a "toJson" method.
-     *
-     * @param JsonableInterface $object The object/value.
-     * @param EE_Base_Class     $source The source object.
-     * @return string JSON representation of the object.
-     */
-    public function toJson(JsonableInterface $object, EE_Base_Class $source): string
-    {
-        return $object->toJson();
-    }
+	/**
+	 * The graphql namespace/prefix.
+	 */
+	protected string $namespace   = 'Espresso';
+
+	protected ?EEM_Base $model       = null;
+
+	protected string $name        = '';
+
+	protected string $description = '';
+
+	/**
+	 * @var GraphQLFieldInterface[] $fields
+	 */
+	protected array $fields              = [];
+
+	/**
+	 * @var GraphQLInterfaceInterface[] $interfaces
+	 */
+	protected array $interfaces          = [];
+
+	protected FieldResolver $field_resolver;
+
+	protected bool $is_custom_post_type = false;
+
+
+	/**
+	 * TypeBase constructor.
+	 *
+	 * @param EEM_Base|null $model
+	 */
+	public function __construct(EEM_Base $model = null)
+	{
+		$this->model = $model;
+		$this->setFields($this->getFields());
+		$this->field_resolver = new FieldResolver(
+			$this->model,
+			$this->getFieldsForResolver()
+		);
+	}
+
+
+	/**
+	 * @return GraphQLFieldInterface[]
+	 * @since 5.0.0.p
+	 */
+	abstract protected function getFields(): array;
+
+
+	/**
+	 * @return string
+	 */
+	public function name(): string
+	{
+		return $this->name;
+	}
+
+
+	/**
+	 * @param string $name
+	 */
+	protected function setName(string $name)
+	{
+		$this->name = $name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function description(): string
+	{
+		return $this->description;
+	}
+
+
+	/**
+	 * @param string $description
+	 */
+	protected function setDescription(string $description)
+	{
+		$this->description = $description;
+	}
+
+
+	/**
+	 * @return GraphQLFieldInterface[]
+	 * @since 5.0.0.p
+	 */
+	public function fields(): array
+	{
+		return $this->fields;
+	}
+
+
+	/**
+	 * @param GraphQLFieldInterface[] $fields
+	 */
+	protected function setFields(array $fields)
+	{
+		foreach ($fields as $field) {
+			if ($field instanceof GraphQLField) {
+				$this->fields[] = $field;
+			}
+		}
+	}
+
+
+	/**
+	 * Creates a key map for internal resolver.
+	 *
+	 * @return array
+	 * @since 5.0.0.p
+	 */
+	public function getFieldsForResolver(): array
+	{
+		$fields = [];
+		foreach ($this->fields() as $field) {
+			if ($field->useForOutput()) {
+				$fields[ $field->name() ] = $field;
+			}
+		}
+		return $fields;
+	}
+
+
+	public function interfaces(): array
+	{
+		return $this->interfaces;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCustomPostType(): bool
+	{
+		return $this->is_custom_post_type;
+	}
+
+
+	/**
+	 * @param bool $is_custom_post_type
+	 */
+	protected function setIsCustomPostType(bool $is_custom_post_type)
+	{
+		$this->is_custom_post_type = filter_var($is_custom_post_type, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @param int|float $value
+	 * @return int
+	 * @since 5.0.0.p
+	 */
+	public function parseInfiniteValue($value): int
+	{
+		$value = trim((string) $value);
+		return $value === ''
+			   || $value === '∞'
+			   || $value === 'INF'
+			   || $value === INF
+			   || $value === EE_INF
+			   || is_infinite((float) $value)
+			? -1
+			: $value;
+	}
+
+
+	/**
+	 * @param mixed $source
+	 * @return EE_Base_Class|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function getModel($source): ?EE_Base_Class
+	{
+		// If it comes from a custom connection
+		// where the $source is already instantiated.
+		if ($source instanceof EE_Base_Class) {
+			return $source;
+		}
+		return $source instanceof Post
+			? $this->model->get_one_by_ID($source->ID)
+			: null;
+	}
+
+
+	/**
+	 * @param mixed       $source  The source that's passed down the GraphQL queries
+	 * @param array       $args    The inputArgs on the field
+	 * @param AppContext  $context The AppContext passed down the GraphQL tree
+	 * @param ResolveInfo $info    The ResolveInfo passed down the GraphQL tree
+	 * @return EE_Base_Class|Deferred|string|null
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws UnexpectedEntityException
+	 * @throws UserError
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 5.0.0.p
+	 */
+	public function resolveField($source, array $args, AppContext $context, ResolveInfo $info)
+	{
+		$source = $source instanceof RootQuery
+			? $source
+			: $this->getModel($source);
+
+		return $this->field_resolver->resolve($source, $args, $context, $info);
+	}
+
+
+	/**
+	 * @param mixed      $payload The payload returned after mutation
+	 * @param array      $args    The inputArgs on the field
+	 * @param AppContext $context The AppContext passed down the GraphQL tree
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function resolveFromPayload($payload, array $args, AppContext $context)
+	{
+		if (empty($payload['id'])) {
+			return null;
+		}
+		return $this->model->get_one_by_ID($payload['id']);
+	}
+
+
+	/**
+	 * Prepares a datetime value in ISO8601/RFC3339 format.
+	 * It is assumed that the value of $datetime is in the format
+	 * returned by EE_Base_Class::get_format().
+	 *
+	 * @param string        $datetime The datetime value.
+	 * @param EE_Base_Class $source   The source object.
+	 * @return string ISO8601/RFC3339 formatted datetime.
+	 * @throws Exception
+	 */
+	public function formatDatetime(string $datetime, EE_Base_Class $source): string
+	{
+		$format = $source->get_format();
+		// create date object based on local timezone
+		$datetime = DateTime::createFromFormat($format, $datetime, new DateTimeZone($source->get_timezone()));
+		// change the timezone to UTC
+		$datetime->setTimezone(new DateTimeZone('UTC'));
+
+		return $datetime->format(DateTimeInterface::RFC3339);
+	}
+
+
+	/**
+	 * Converts an object to JSON. The object must have a "toJson" method.
+	 *
+	 * @param JsonableInterface $object The object/value.
+	 * @param EE_Base_Class     $source The source object.
+	 * @return string JSON representation of the object.
+	 */
+	public function toJson(JsonableInterface $object, EE_Base_Class $source): string
+	{
+		return $object->toJson();
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -40,9 +40,9 @@ 
     /**
      * The graphql namespace/prefix.
      */
-    protected string $namespace   = 'Espresso';
+    protected string $namespace = 'Espresso';
 
-    protected ?EEM_Base $model       = null;
+    protected ?EEM_Base $model = null;
 
     protected string $name        = '';
 
@@ -51,12 +51,12 @@ 
     /**
      * @var GraphQLFieldInterface[] $fields
      */
-    protected array $fields              = [];
+    protected array $fields = [];
 
     /**
      * @var GraphQLInterfaceInterface[] $interfaces
      */
-    protected array $interfaces          = [];
+    protected array $interfaces = [];
 
     protected FieldResolver $field_resolver;
 
@@ -156,7 +156,7 @@ 
         $fields = [];
         foreach ($this->fields() as $field) {
             if ($field->useForOutput()) {
-                $fields[ $field->name() ] = $field;
+                $fields[$field->name()] = $field;
             }
         }
         return $fields;

core/services/bootstrap/BootstrapRequestResponseObjects.php

Indentation +73 added lines, -73 removed lines

@@ -29,88 +29,88 @@
  */
 class BootstrapRequestResponseObjects
 {
-    protected LegacyRequestInterface $legacy_request;
+	protected LegacyRequestInterface $legacy_request;
 
-    protected LoaderInterface $loader;
+	protected LoaderInterface $loader;
 
-    protected RequestInterface $request;
+	protected RequestInterface $request;
 
-    protected ResponseInterface $response;
+	protected ResponseInterface $response;
 
 
-    /**
-     * BootstrapRequestResponseObjects constructor.
-     *
-     * @param LoaderInterface $loader
-     */
-    public function __construct(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
+	/**
+	 * BootstrapRequestResponseObjects constructor.
+	 *
+	 * @param LoaderInterface $loader
+	 */
+	public function __construct(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
 
 
-    /**
-     * @return void
-     */
-    public function buildRequestResponse()
-    {
-        $email_validator   = new Basic();
-        $request_sanitizer = new RequestSanitizer($email_validator);
-        $server_sanitizer  = new ServerSanitizer();
-        $request_params    = new RequestParams($request_sanitizer, $_GET, $_POST);
-        $server_params     = new ServerParams($server_sanitizer, $_SERVER);
-        // load our Request and Response objects
-        $this->request  = apply_filters(
-            'FHEE___EventEspresso_core_services_bootstrap_BootstrapRequestResponseObjects__buildRequestResponse__request',
-            new Request($request_params, $server_params),
-            $request_params,
-            $server_params,
-            $request_sanitizer,
-            $server_sanitizer
-        );
-        $this->response = apply_filters(
-            'FHEE___EventEspresso_core_services_bootstrap_BootstrapRequestResponseObjects__buildRequestResponse__response',
-            new Response()
-        );
-        $this->loader->share(Basic::class, $email_validator);
-        $this->loader->share(RequestSanitizer::class, $request_sanitizer);
-        $this->loader->share(ServerSanitizer::class, $server_sanitizer);
-        $this->loader->share(RequestParams::class, $request_params);
-        $this->loader->share(ServerParams::class, $server_params);
-    }
+	/**
+	 * @return void
+	 */
+	public function buildRequestResponse()
+	{
+		$email_validator   = new Basic();
+		$request_sanitizer = new RequestSanitizer($email_validator);
+		$server_sanitizer  = new ServerSanitizer();
+		$request_params    = new RequestParams($request_sanitizer, $_GET, $_POST);
+		$server_params     = new ServerParams($server_sanitizer, $_SERVER);
+		// load our Request and Response objects
+		$this->request  = apply_filters(
+			'FHEE___EventEspresso_core_services_bootstrap_BootstrapRequestResponseObjects__buildRequestResponse__request',
+			new Request($request_params, $server_params),
+			$request_params,
+			$server_params,
+			$request_sanitizer,
+			$server_sanitizer
+		);
+		$this->response = apply_filters(
+			'FHEE___EventEspresso_core_services_bootstrap_BootstrapRequestResponseObjects__buildRequestResponse__response',
+			new Response()
+		);
+		$this->loader->share(Basic::class, $email_validator);
+		$this->loader->share(RequestSanitizer::class, $request_sanitizer);
+		$this->loader->share(ServerSanitizer::class, $server_sanitizer);
+		$this->loader->share(RequestParams::class, $request_params);
+		$this->loader->share(ServerParams::class, $server_params);
+	}
 
 
-    /**
-     * @return void
-     * @throws InvalidArgumentException
-     */
-    public function shareRequestResponse()
-    {
-        $this->loader->share(Request::class, $this->request);
-        $this->loader->share(Response::class, $this->response);
-        EE_Dependency_Map::instance()->setRequest($this->request);
-        EE_Dependency_Map::instance()->setResponse($this->response);
-    }
+	/**
+	 * @return void
+	 * @throws InvalidArgumentException
+	 */
+	public function shareRequestResponse()
+	{
+		$this->loader->share(Request::class, $this->request);
+		$this->loader->share(Response::class, $this->response);
+		EE_Dependency_Map::instance()->setRequest($this->request);
+		EE_Dependency_Map::instance()->setResponse($this->response);
+	}
 
 
-    /**
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     */
-    public function setupLegacyRequest()
-    {
-        espresso_load_required(
-            'EE_Request',
-            EE_CORE . 'request_stack/EE_Request.core.php'
-        );
-        $this->legacy_request = new EE_Request($_GET, $_POST, $_COOKIE, $_SERVER);
-        $this->legacy_request->setRequest($this->request);
-        $this->legacy_request->admin      = $this->request->isAdmin();
-        $this->legacy_request->ajax       = $this->request->isAjax();
-        $this->legacy_request->front_ajax = $this->request->isFrontAjax();
-        EE_Dependency_Map::instance()->setLegacyRequest($this->legacy_request);
-        $this->loader->share('EE_Request', $this->legacy_request);
-        $this->loader->share('EventEspresso\core\services\request\LegacyRequestInterface', $this->legacy_request);
-    }
+	/**
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 */
+	public function setupLegacyRequest()
+	{
+		espresso_load_required(
+			'EE_Request',
+			EE_CORE . 'request_stack/EE_Request.core.php'
+		);
+		$this->legacy_request = new EE_Request($_GET, $_POST, $_COOKIE, $_SERVER);
+		$this->legacy_request->setRequest($this->request);
+		$this->legacy_request->admin      = $this->request->isAdmin();
+		$this->legacy_request->ajax       = $this->request->isAjax();
+		$this->legacy_request->front_ajax = $this->request->isFrontAjax();
+		EE_Dependency_Map::instance()->setLegacyRequest($this->legacy_request);
+		$this->loader->share('EE_Request', $this->legacy_request);
+		$this->loader->share('EventEspresso\core\services\request\LegacyRequestInterface', $this->legacy_request);
+	}
 }

core/services/bootstrap/BootstrapDependencyInjectionContainer.php

Indentation +101 added lines, -101 removed lines

@@ -24,105 +24,105 @@
  */
 class BootstrapDependencyInjectionContainer
 {
-    private ClassInterfaceCache $class_cache;
-
-    private Mirror $mirror;
-
-    private ObjectIdentifier $object_identifier;
-
-    protected EE_Dependency_Map $dependency_map;
-
-    protected EE_Registry $registry;
-
-    protected LoaderInterface $loader;
-
-
-    // /**
-    //  * Can't use this just yet until we exorcise some more of our singleton usage from core
-    //  */
-    // public function buildDependencyInjectionContainer()
-    // {
-    //      // build DI container
-    //      $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop();
-    //      $OpenCoffeeShop->addRecipes();
-    //      $CoffeeShop = $OpenCoffeeShop->CoffeeShop();
-    // }
-
-
-    /**
-     * Setups  EE_Registry and EE_Dependency_Map
-     *
-     * @throws EE_Error
-     */
-    public function buildLegacyDependencyInjectionContainer()
-    {
-        $this->class_cache       = new ClassInterfaceCache();
-        $this->object_identifier = new ObjectIdentifier($this->class_cache);
-        $this->mirror            = new Mirror();
-        // EE_Dependency_Map: info about how to load classes required by other classes
-        espresso_load_required(
-            'EE_Dependency_Map',
-            EE_CORE . 'EE_Dependency_Map.core.php'
-        );
-        $this->dependency_map = EE_Dependency_Map::instance($this->class_cache);
-        // EE_Registry: central repository for classes (legacy)
-        espresso_load_required(
-            'EE_Registry',
-            EE_CORE . 'EE_Registry.core.php'
-        );
-        $this->registry = EE_Registry::instance(
-            $this->dependency_map,
-            $this->mirror,
-            $this->class_cache,
-            $this->object_identifier
-        );
-    }
-
-
-    /**
-     * Performs initial setup for the generic Loader
-     *
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function buildLoader()
-    {
-        $this->loader = LoaderFactory::getLoader(
-            $this->registry,
-            $this->class_cache,
-            $this->object_identifier
-        );
-        $this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache);
-        $this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier);
-        $this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror);
-        $this->dependency_map->setLoader($this->loader);
-    }
-
-
-    /**
-     * @return EE_Dependency_Map
-     */
-    public function getDependencyMap(): EE_Dependency_Map
-    {
-        return $this->dependency_map;
-    }
-
-
-    /**
-     * @return EE_Registry
-     */
-    public function getRegistry(): EE_Registry
-    {
-        return $this->registry;
-    }
-
-
-    /**
-     * @return LoaderInterface
-     */
-    public function getLoader(): LoaderInterface
-    {
-        return $this->loader;
-    }
+	private ClassInterfaceCache $class_cache;
+
+	private Mirror $mirror;
+
+	private ObjectIdentifier $object_identifier;
+
+	protected EE_Dependency_Map $dependency_map;
+
+	protected EE_Registry $registry;
+
+	protected LoaderInterface $loader;
+
+
+	// /**
+	//  * Can't use this just yet until we exorcise some more of our singleton usage from core
+	//  */
+	// public function buildDependencyInjectionContainer()
+	// {
+	//      // build DI container
+	//      $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop();
+	//      $OpenCoffeeShop->addRecipes();
+	//      $CoffeeShop = $OpenCoffeeShop->CoffeeShop();
+	// }
+
+
+	/**
+	 * Setups  EE_Registry and EE_Dependency_Map
+	 *
+	 * @throws EE_Error
+	 */
+	public function buildLegacyDependencyInjectionContainer()
+	{
+		$this->class_cache       = new ClassInterfaceCache();
+		$this->object_identifier = new ObjectIdentifier($this->class_cache);
+		$this->mirror            = new Mirror();
+		// EE_Dependency_Map: info about how to load classes required by other classes
+		espresso_load_required(
+			'EE_Dependency_Map',
+			EE_CORE . 'EE_Dependency_Map.core.php'
+		);
+		$this->dependency_map = EE_Dependency_Map::instance($this->class_cache);
+		// EE_Registry: central repository for classes (legacy)
+		espresso_load_required(
+			'EE_Registry',
+			EE_CORE . 'EE_Registry.core.php'
+		);
+		$this->registry = EE_Registry::instance(
+			$this->dependency_map,
+			$this->mirror,
+			$this->class_cache,
+			$this->object_identifier
+		);
+	}
+
+
+	/**
+	 * Performs initial setup for the generic Loader
+	 *
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function buildLoader()
+	{
+		$this->loader = LoaderFactory::getLoader(
+			$this->registry,
+			$this->class_cache,
+			$this->object_identifier
+		);
+		$this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache);
+		$this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier);
+		$this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror);
+		$this->dependency_map->setLoader($this->loader);
+	}
+
+
+	/**
+	 * @return EE_Dependency_Map
+	 */
+	public function getDependencyMap(): EE_Dependency_Map
+	{
+		return $this->dependency_map;
+	}
+
+
+	/**
+	 * @return EE_Registry
+	 */
+	public function getRegistry(): EE_Registry
+	{
+		return $this->registry;
+	}
+
+
+	/**
+	 * @return LoaderInterface
+	 */
+	public function getLoader(): LoaderInterface
+	{
+		return $this->loader;
+	}
 }

core/services/bootstrap/BootstrapCore.php

Indentation +186 added lines, -186 removed lines

@@ -53,212 +53,212 @@
  */
 class BootstrapCore
 {
-    private LoaderInterface $loader;
+	private LoaderInterface $loader;
 
-    protected RequestInterface $request;
+	protected RequestInterface $request;
 
-    protected ResponseInterface $response;
+	protected ResponseInterface $response;
 
-    protected RequestStackBuilder $request_stack_builder;
+	protected RequestStackBuilder $request_stack_builder;
 
-    protected RequestStack $request_stack;
+	protected RequestStack $request_stack;
 
 
-    /**
-     * BootstrapCore constructor.
-     */
-    public function __construct()
-    {
-        do_action('AHEE__EventEspresso_core_services_bootstrap_BootstrapCore___construct');
-        // construct request stack and run middleware apps as soon as all WP plugins are loaded
-        add_action('plugins_loaded', [$this, 'initialize'], 0);
-    }
+	/**
+	 * BootstrapCore constructor.
+	 */
+	public function __construct()
+	{
+		do_action('AHEE__EventEspresso_core_services_bootstrap_BootstrapCore___construct');
+		// construct request stack and run middleware apps as soon as all WP plugins are loaded
+		add_action('plugins_loaded', [$this, 'initialize'], 0);
+	}
 
 
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws Exception
-     * @throws InvalidArgumentException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFilePathException
-     * @throws InvalidInterfaceException
-     * @throws InvalidRequestStackMiddlewareException
-     * @throws OutOfBoundsException
-     * @throws ReflectionException
-     * @throws Throwable
-     */
-    public function initialize()
-    {
-        $this->bootstrapDependencyInjectionContainer();
-        $this->bootstrapDomain();
-        $bootstrap_request = $this->bootstrapRequestResponseObjects();
-        add_action(
-            'EE_Load_Espresso_Core__handle_request__initialize_core_loading',
-            [$bootstrap_request, 'setupLegacyRequest']
-        );
-        $this->runRequestStack();
-    }
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws Exception
+	 * @throws InvalidArgumentException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidRequestStackMiddlewareException
+	 * @throws OutOfBoundsException
+	 * @throws ReflectionException
+	 * @throws Throwable
+	 */
+	public function initialize()
+	{
+		$this->bootstrapDependencyInjectionContainer();
+		$this->bootstrapDomain();
+		$bootstrap_request = $this->bootstrapRequestResponseObjects();
+		add_action(
+			'EE_Load_Espresso_Core__handle_request__initialize_core_loading',
+			[$bootstrap_request, 'setupLegacyRequest']
+		);
+		$this->runRequestStack();
+	}
 
 
-    /**
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws OutOfBoundsException
-     */
-    private function bootstrapDependencyInjectionContainer()
-    {
-        $bootstrap_di = new BootstrapDependencyInjectionContainer();
-        $bootstrap_di->buildLegacyDependencyInjectionContainer();
-        $bootstrap_di->buildLoader();
-        $registry       = $bootstrap_di->getRegistry();
-        $dependency_map = $bootstrap_di->getDependencyMap();
-        $dependency_map->initialize();
-        $registry->initialize();
-        $this->loader = $bootstrap_di->getLoader();
-    }
+	/**
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws OutOfBoundsException
+	 */
+	private function bootstrapDependencyInjectionContainer()
+	{
+		$bootstrap_di = new BootstrapDependencyInjectionContainer();
+		$bootstrap_di->buildLegacyDependencyInjectionContainer();
+		$bootstrap_di->buildLoader();
+		$registry       = $bootstrap_di->getRegistry();
+		$dependency_map = $bootstrap_di->getDependencyMap();
+		$dependency_map->initialize();
+		$registry->initialize();
+		$this->loader = $bootstrap_di->getLoader();
+	}
 
 
-    /**
-     * configures the Domain object for core
-     *
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws InvalidFilePathException
-     * @throws InvalidInterfaceException
-     */
-    private function bootstrapDomain()
-    {
-        DomainFactory::getEventEspressoCoreDomain();
-    }
+	/**
+	 * configures the Domain object for core
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidInterfaceException
+	 */
+	private function bootstrapDomain()
+	{
+		DomainFactory::getEventEspressoCoreDomain();
+	}
 
 
-    /**
-     * sets up the request and response objects
-     *
-     * @return BootstrapRequestResponseObjects
-     * @throws InvalidArgumentException
-     */
-    private function bootstrapRequestResponseObjects(): BootstrapRequestResponseObjects
-    {
-        /** @var BootstrapRequestResponseObjects $bootstrap_request */
-        $bootstrap_request = $this->loader->getShared(
-            'EventEspresso\core\services\bootstrap\BootstrapRequestResponseObjects',
-            [$this->loader]
-        );
-        $bootstrap_request->buildRequestResponse();
-        $bootstrap_request->shareRequestResponse();
-        $this->request  = $this->loader->getShared('EventEspresso\core\services\request\Request');
-        $this->response = $this->loader->getShared('EventEspresso\core\services\request\Response');
-        return $bootstrap_request;
-    }
+	/**
+	 * sets up the request and response objects
+	 *
+	 * @return BootstrapRequestResponseObjects
+	 * @throws InvalidArgumentException
+	 */
+	private function bootstrapRequestResponseObjects(): BootstrapRequestResponseObjects
+	{
+		/** @var BootstrapRequestResponseObjects $bootstrap_request */
+		$bootstrap_request = $this->loader->getShared(
+			'EventEspresso\core\services\bootstrap\BootstrapRequestResponseObjects',
+			[$this->loader]
+		);
+		$bootstrap_request->buildRequestResponse();
+		$bootstrap_request->shareRequestResponse();
+		$this->request  = $this->loader->getShared('EventEspresso\core\services\request\Request');
+		$this->response = $this->loader->getShared('EventEspresso\core\services\request\Response');
+		return $bootstrap_request;
+	}
 
 
-    /**
-     * run_request_stack
-     * construct request stack and run middleware apps
-     *
-     * @throws EE_Error
-     * @throws Exception
-     * @throws Throwable
-     */
-    public function runRequestStack()
-    {
-        $this->loadAutoloader();
-        $this->setAutoloadersForRequiredFiles();
-        $this->request_stack_builder = $this->buildRequestStack();
-        $this->request_stack         = $this->request_stack_builder->resolve(
-            new RequestStackCoreApp()
-        );
-        $this->request_stack->handleRequest($this->request, $this->response);
-        $this->request_stack->handleResponse();
-    }
+	/**
+	 * run_request_stack
+	 * construct request stack and run middleware apps
+	 *
+	 * @throws EE_Error
+	 * @throws Exception
+	 * @throws Throwable
+	 */
+	public function runRequestStack()
+	{
+		$this->loadAutoloader();
+		$this->setAutoloadersForRequiredFiles();
+		$this->request_stack_builder = $this->buildRequestStack();
+		$this->request_stack         = $this->request_stack_builder->resolve(
+			new RequestStackCoreApp()
+		);
+		$this->request_stack->handleRequest($this->request, $this->response);
+		$this->request_stack->handleResponse();
+	}
 
 
-    /**
-     * load_autoloader
-     *
-     * @throws EE_Error
-     */
-    protected function loadAutoloader()
-    {
-        // load interfaces
-        espresso_load_required(
-            'EEH_Autoloader',
-            EE_CORE . 'helpers/EEH_Autoloader.helper.php'
-        );
-        EEH_Autoloader::instance();
-    }
+	/**
+	 * load_autoloader
+	 *
+	 * @throws EE_Error
+	 */
+	protected function loadAutoloader()
+	{
+		// load interfaces
+		espresso_load_required(
+			'EEH_Autoloader',
+			EE_CORE . 'helpers/EEH_Autoloader.helper.php'
+		);
+		EEH_Autoloader::instance();
+	}
 
 
-    /**
-     * load_required_files
-     *
-     * @throws EE_Error
-     */
-    protected function setAutoloadersForRequiredFiles()
-    {
-        // load interfaces
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'interfaces', true);
-        // load helpers
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_HELPERS);
-        // register legacy request stack classes just in case
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'request_stack/');
-        // register legacy middleware classes just in case
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'middleware/');
-    }
+	/**
+	 * load_required_files
+	 *
+	 * @throws EE_Error
+	 */
+	protected function setAutoloadersForRequiredFiles()
+	{
+		// load interfaces
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'interfaces', true);
+		// load helpers
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_HELPERS);
+		// register legacy request stack classes just in case
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'request_stack/');
+		// register legacy middleware classes just in case
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'middleware/');
+	}
 
 
-    /**
-     * build_request_stack
-     *
-     * @return RequestStackBuilder
-     */
-    public function buildRequestStack(): RequestStackBuilder
-    {
-        $request_stack_builder = new RequestStackBuilder($this->loader);
-        /**
-         * ! IMPORTANT ! The middleware stack operates FILO : FIRST IN LAST OUT
-         * so items at the beginning of the final middleware stack will run last.
-         * First parameter is the middleware classname, second is an array of arguments
-         */
-        $stack_apps = apply_filters(
-            'FHEE__EventEspresso_core_services_bootstrap_BootstrapCore__buildRequestStack__stack_apps',
-            [
-                // first in last out
-                BotDetector::class                 => [],
-                DetectFileEditorRequest::class     => [],
-                PreProductionVersionWarning::class => [],
-                RecommendedVersions::class         => [],
-                // last in first out
-                DetectLogin::class                 => [],
-            ]
-        );
-        // legacy filter for backwards compatibility
-        $stack_apps = apply_filters(
-            'FHEE__EE_Bootstrap__build_request_stack__stack_apps',
-            $stack_apps
-        );
-        // load middleware onto stack : FILO (First In Last Out)
-        // items at the beginning of the $stack_apps array will run last
-        foreach ((array) $stack_apps as $stack_app => $stack_app_args) {
-            $request_stack_builder->push([$stack_app, $stack_app_args]);
-        }
-        // finally, we'll add this on its own because we need it to always be part of the stack
-        // and we also need it to always run first because the rest of the system relies on it
-        $request_stack_builder->push(
-            [SetRequestTypeContextChecker::class, []]
-        );
-        return apply_filters(
-            'FHEE__EE_Bootstrap__build_request_stack__request_stack_builder',
-            $request_stack_builder
-        );
-    }
+	/**
+	 * build_request_stack
+	 *
+	 * @return RequestStackBuilder
+	 */
+	public function buildRequestStack(): RequestStackBuilder
+	{
+		$request_stack_builder = new RequestStackBuilder($this->loader);
+		/**
+		 * ! IMPORTANT ! The middleware stack operates FILO : FIRST IN LAST OUT
+		 * so items at the beginning of the final middleware stack will run last.
+		 * First parameter is the middleware classname, second is an array of arguments
+		 */
+		$stack_apps = apply_filters(
+			'FHEE__EventEspresso_core_services_bootstrap_BootstrapCore__buildRequestStack__stack_apps',
+			[
+				// first in last out
+				BotDetector::class                 => [],
+				DetectFileEditorRequest::class     => [],
+				PreProductionVersionWarning::class => [],
+				RecommendedVersions::class         => [],
+				// last in first out
+				DetectLogin::class                 => [],
+			]
+		);
+		// legacy filter for backwards compatibility
+		$stack_apps = apply_filters(
+			'FHEE__EE_Bootstrap__build_request_stack__stack_apps',
+			$stack_apps
+		);
+		// load middleware onto stack : FILO (First In Last Out)
+		// items at the beginning of the $stack_apps array will run last
+		foreach ((array) $stack_apps as $stack_app => $stack_app_args) {
+			$request_stack_builder->push([$stack_app, $stack_app_args]);
+		}
+		// finally, we'll add this on its own because we need it to always be part of the stack
+		// and we also need it to always run first because the rest of the system relies on it
+		$request_stack_builder->push(
+			[SetRequestTypeContextChecker::class, []]
+		);
+		return apply_filters(
+			'FHEE__EE_Bootstrap__build_request_stack__request_stack_builder',
+			$request_stack_builder
+		);
+	}
 }

core/services/payments/RegistrationPayments.php

Indentation +160 added lines, -160 removed lines

@@ -22,174 +22,174 @@
  */
 class RegistrationPayments
 {
-    /**
-     * update registrations REG_paid field after successful payment and link registrations with payment
-     *
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment        $payment
-     * @param EE_Registration[] $registrations
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function processRegistrationPayments(
-        EE_Transaction $transaction,
-        EE_Payment $payment,
-        array $registrations = []
-    ) {
-        // only process if payment was successful
-        if ($payment->status() !== EEM_Payment::status_id_approved) {
-            return;
-        }
-        $registrations = $this->loadRegistrationsIfMissing($transaction, $registrations);
-        // still nothing ??!??
-        if (empty($registrations)) {
-            return;
-        }
-        // todo: break out the following logic into a separate strategy class
-        // todo: named something like "Sequential_Reg_Payment_Strategy"
-        // todo: which would apply payments using the capitalist "first come first paid" approach
-        // todo: then have another strategy class like "Distributed_Reg_Payment_Strategy"
-        // todo: which would be the socialist "everybody gets a piece of pie" approach,
-        // todo: which would be better for deposits, where you want a bit of the payment applied to each registration
-        $available_payment_amount = $this->sequentialRegPaymentStrategy($payment, $registrations);
-        $this->remainderNotice($payment, $available_payment_amount, $registrations);
-    }
+	/**
+	 * update registrations REG_paid field after successful payment and link registrations with payment
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment        $payment
+	 * @param EE_Registration[] $registrations
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function processRegistrationPayments(
+		EE_Transaction $transaction,
+		EE_Payment $payment,
+		array $registrations = []
+	) {
+		// only process if payment was successful
+		if ($payment->status() !== EEM_Payment::status_id_approved) {
+			return;
+		}
+		$registrations = $this->loadRegistrationsIfMissing($transaction, $registrations);
+		// still nothing ??!??
+		if (empty($registrations)) {
+			return;
+		}
+		// todo: break out the following logic into a separate strategy class
+		// todo: named something like "Sequential_Reg_Payment_Strategy"
+		// todo: which would apply payments using the capitalist "first come first paid" approach
+		// todo: then have another strategy class like "Distributed_Reg_Payment_Strategy"
+		// todo: which would be the socialist "everybody gets a piece of pie" approach,
+		// todo: which would be better for deposits, where you want a bit of the payment applied to each registration
+		$available_payment_amount = $this->sequentialRegPaymentStrategy($payment, $registrations);
+		$this->remainderNotice($payment, $available_payment_amount, $registrations);
+	}
 
 
-    /**
-     * @param EE_Transaction $transaction
-     * @param array          $registrations
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function loadRegistrationsIfMissing(EE_Transaction $transaction, array $registrations = []): array
-    {
-        if (empty($registrations)) {
-            // find registrations with monies owing that can receive a payment
-            $registrations = $transaction->registrations(
-                [
-                    [
-                        // only these reg statuses can receive payments
-                        'STS_ID'           => ['IN', EEM_Registration::reg_statuses_that_allow_payment()],
-                        'REG_final_price'  => ['!=', 0],
-                        'REG_final_price*' => ['!=', 'REG_paid', true],
-                    ],
-                ]
-            );
-        }
-        return $registrations;
-    }
+	/**
+	 * @param EE_Transaction $transaction
+	 * @param array          $registrations
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function loadRegistrationsIfMissing(EE_Transaction $transaction, array $registrations = []): array
+	{
+		if (empty($registrations)) {
+			// find registrations with monies owing that can receive a payment
+			$registrations = $transaction->registrations(
+				[
+					[
+						// only these reg statuses can receive payments
+						'STS_ID'           => ['IN', EEM_Registration::reg_statuses_that_allow_payment()],
+						'REG_final_price'  => ['!=', 0],
+						'REG_final_price*' => ['!=', 'REG_paid', true],
+					],
+				]
+			);
+		}
+		return $registrations;
+	}
 
 
-    /**
-     * @param EE_Payment $payment
-     * @param array      $registrations
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function sequentialRegPaymentStrategy(EE_Payment $payment, array $registrations): float
-    {
-        $refund = $payment->is_a_refund();
-        // how much is available to apply to registrations?
-        $available_payment_amount = (float) abs($payment->amount());
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration) {
-                // nothing left?
-                if ($available_payment_amount <= 0) {
-                    break;
-                }
-                if ($refund) {
-                    $available_payment_amount = $this->processRegistrationRefund(
-                        $registration,
-                        $payment,
-                        $available_payment_amount
-                    );
-                } else {
-                    $available_payment_amount = $this->processRegistrationPayment(
-                        $registration,
-                        $payment,
-                        $available_payment_amount
-                    );
-                }
-            }
-        }
-        return $available_payment_amount;
-    }
+	/**
+	 * @param EE_Payment $payment
+	 * @param array      $registrations
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function sequentialRegPaymentStrategy(EE_Payment $payment, array $registrations): float
+	{
+		$refund = $payment->is_a_refund();
+		// how much is available to apply to registrations?
+		$available_payment_amount = (float) abs($payment->amount());
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration) {
+				// nothing left?
+				if ($available_payment_amount <= 0) {
+					break;
+				}
+				if ($refund) {
+					$available_payment_amount = $this->processRegistrationRefund(
+						$registration,
+						$payment,
+						$available_payment_amount
+					);
+				} else {
+					$available_payment_amount = $this->processRegistrationPayment(
+						$registration,
+						$payment,
+						$available_payment_amount
+					);
+				}
+			}
+		}
+		return $available_payment_amount;
+	}
 
 
-    /**
-     * @throws EE_Error
-     */
-    private function remainderNotice(EE_Payment $payment, float $available_payment_amount, array $registrations)
-    {
-        if (
-            $available_payment_amount > 0
-            && apply_filters(
-                'FHEE__EE_Payment_Processor__process_registration_payments__display_notifications',
-                false
-            )
-        ) {
-            EE_Error::add_attention(
-                sprintf(
-                    esc_html__(
-                        'A remainder of %1$s exists after applying this payment to Registration(s) %2$s.%3$sPlease verify that the original payment amount of %4$s is correct. If so, you should edit this payment and select at least one additional registration in the "Registrations to Apply Payment to" section, so that the remainder of this payment can be applied to the additional registration(s).',
-                        'event_espresso'
-                    ),
-                    EEH_Template::format_currency($available_payment_amount),
-                    implode(', ', array_keys($registrations)),
-                    '<br/>',
-                    EEH_Template::format_currency($payment->amount())
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
+	/**
+	 * @throws EE_Error
+	 */
+	private function remainderNotice(EE_Payment $payment, float $available_payment_amount, array $registrations)
+	{
+		if (
+			$available_payment_amount > 0
+			&& apply_filters(
+				'FHEE__EE_Payment_Processor__process_registration_payments__display_notifications',
+				false
+			)
+		) {
+			EE_Error::add_attention(
+				sprintf(
+					esc_html__(
+						'A remainder of %1$s exists after applying this payment to Registration(s) %2$s.%3$sPlease verify that the original payment amount of %4$s is correct. If so, you should edit this payment and select at least one additional registration in the "Registrations to Apply Payment to" section, so that the remainder of this payment can be applied to the additional registration(s).',
+						'event_espresso'
+					),
+					EEH_Template::format_currency($available_payment_amount),
+					implode(', ', array_keys($registrations)),
+					'<br/>',
+					EEH_Template::format_currency($payment->amount())
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
 
 
-    /**
-     * update registration REG_paid field after successful payment and link registration with payment
-     *
-     * @param EE_Registration  $registration
-     * @param EE_Payment       $payment
-     * @param float            $available_payment_amount
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws ReflectionException
-     */
-    public function processRegistrationPayment(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        float $available_payment_amount = 0.00
-    ): float {
-        // update $available_payment_amount
-        $available_payment_amount -= $registration->applyPayment($payment, $available_payment_amount);
-        return $available_payment_amount;
-    }
+	/**
+	 * update registration REG_paid field after successful payment and link registration with payment
+	 *
+	 * @param EE_Registration  $registration
+	 * @param EE_Payment       $payment
+	 * @param float            $available_payment_amount
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws ReflectionException
+	 */
+	public function processRegistrationPayment(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		float $available_payment_amount = 0.00
+	): float {
+		// update $available_payment_amount
+		$available_payment_amount -= $registration->applyPayment($payment, $available_payment_amount);
+		return $available_payment_amount;
+	}
 
 
-    /**
-     * update registration REG_paid field after refund and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $available_refund_amount - IMPORTANT !!! SEND AVAILABLE REFUND AMOUNT AS A POSITIVE NUMBER
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws ReflectionException
-     */
-    public function processRegistrationRefund(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        float $available_refund_amount = 0.00
-    ): float {
-        // update $available_payment_amount
-        $available_refund_amount -= $registration->applyPayment($payment, $available_refund_amount);
-        return $available_refund_amount;
-    }
+	/**
+	 * update registration REG_paid field after refund and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $available_refund_amount - IMPORTANT !!! SEND AVAILABLE REFUND AMOUNT AS A POSITIVE NUMBER
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws ReflectionException
+	 */
+	public function processRegistrationRefund(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		float $available_refund_amount = 0.00
+	): float {
+		// update $available_payment_amount
+		$available_refund_amount -= $registration->applyPayment($payment, $available_refund_amount);
+		return $available_refund_amount;
+	}
 }

core/services/payments/PaymentProcessor.php

Indentation +292 added lines, -292 removed lines

@@ -29,316 +29,316 @@
  */
 class PaymentProcessor
 {
-    private EEM_Payment_Method $payment_method_model;
+	private EEM_Payment_Method $payment_method_model;
 
-    private EEM_Transaction $transaction_model;
+	private EEM_Transaction $transaction_model;
 
-    private EE_Organization_Config $organization;
+	private EE_Organization_Config $organization;
 
-    private FeatureFlags $feature;
+	private FeatureFlags $feature;
 
-    private PaymentProcessorFees $payment_processor_fees;
+	private PaymentProcessorFees $payment_processor_fees;
 
-    private PostPaymentProcessor $post_payment_processor;
+	private PostPaymentProcessor $post_payment_processor;
 
-    private RegistrationPayments $registration_payments;
+	private RegistrationPayments $registration_payments;
 
 
-    /**
-     * @param EEM_Payment_Method     $payment_method_model
-     * @param EEM_Transaction        $transaction_model
-     * @param EE_Organization_Config $organization
-     * @param FeatureFlags           $feature
-     * @param PaymentProcessorFees   $payment_processor_fees
-     * @param PostPaymentProcessor   $post_payment_processor
-     * @param RegistrationPayments   $registration_payments
-     */
-    public function __construct(
-        EEM_Payment_Method $payment_method_model,
-        EEM_Transaction $transaction_model,
-        EE_Organization_Config $organization,
-        FeatureFlags $feature,
-        PaymentProcessorFees $payment_processor_fees,
-        PostPaymentProcessor $post_payment_processor,
-        RegistrationPayments $registration_payments
-    ) {
-        $this->payment_method_model   = $payment_method_model;
-        $this->transaction_model      = $transaction_model;
-        $this->organization           = $organization;
-        $this->feature                = $feature;
-        $this->payment_processor_fees = $payment_processor_fees;
-        $this->post_payment_processor = $post_payment_processor;
-        $this->registration_payments  = $registration_payments;
-    }
+	/**
+	 * @param EEM_Payment_Method     $payment_method_model
+	 * @param EEM_Transaction        $transaction_model
+	 * @param EE_Organization_Config $organization
+	 * @param FeatureFlags           $feature
+	 * @param PaymentProcessorFees   $payment_processor_fees
+	 * @param PostPaymentProcessor   $post_payment_processor
+	 * @param RegistrationPayments   $registration_payments
+	 */
+	public function __construct(
+		EEM_Payment_Method $payment_method_model,
+		EEM_Transaction $transaction_model,
+		EE_Organization_Config $organization,
+		FeatureFlags $feature,
+		PaymentProcessorFees $payment_processor_fees,
+		PostPaymentProcessor $post_payment_processor,
+		RegistrationPayments $registration_payments
+	) {
+		$this->payment_method_model   = $payment_method_model;
+		$this->transaction_model      = $transaction_model;
+		$this->organization           = $organization;
+		$this->feature                = $feature;
+		$this->payment_processor_fees = $payment_processor_fees;
+		$this->post_payment_processor = $post_payment_processor;
+		$this->registration_payments  = $registration_payments;
+	}
 
 
-    /**
-     * Using the selected gateway, processes the payment for that transaction, and updates the transaction
-     * appropriately. Saves the payment that is generated
-     *
-     * @param EE_Payment_Method         $payment_method
-     * @param EE_Transaction            $transaction
-     * @param EE_Billing_Info_Form|null $billing_form  (or probably null, if it's an offline or offsite payment
-     *                                                 method).
-     *                                                 Receive_form_submission() should have
-     *                                                 already been called on the billing form
-     *                                                 (ie, its inputs should have their normalized values set).
-     * @param float                     $amount        if only part of the transaction is to be paid for, how much.
-     *                                                 Leave null if payment is for the full amount owing
-     * @param bool                      $by_admin      TRUE if payment is being attempted from the admin
-     * @param bool                      $update_txn    whether to call EE_Transaction_Processor
-     *                                                 ::update_transaction_and_registrations_after_checkout_or_payment()
-     * @param string                    $return_url    string used mostly by offsite gateways to specify
-     *                                                 where to go AFTER the offsite gateway
-     * @param string                    $cancel_url    URL to return to if off-site payments are cancelled
-     * @param string                    $method        like 'CART', indicates who the client who called this was
-     * @return EE_Payment|null
-     * @throws EE_Error
-     * @throws Exception
-     * @throws ReflectionException
-     */
-    public function processPayment(
-        EE_Payment_Method $payment_method,
-        EE_Transaction $transaction,
-        ?EE_Billing_Info_Form $billing_form = null,
-        float $amount = 0.00,
-        bool $by_admin = false,
-        bool $update_txn = true,
-        string $return_url = '',
-        string $cancel_url = '',
-        string $method = 'CART'
-    ): ?EE_Payment {
-        $this->validatePaymentAmount($transaction, $amount);
-        // verify payment method
-        $payment_method = $this->payment_method_model->ensure_is_obj(
-            $payment_method,
-            true
-        );
-        // verify transaction
-        $this->transaction_model->ensure_is_obj($transaction);
-        $transaction->set_payment_method_ID($payment_method->ID());
-        // make sure we don't overcharge
-        $amount = min($amount, $transaction->remaining());
-        // TODO: add some extra logic to PaymentProcessorFees to designate where/when partner fees are applied based on the PM being used.
-        // if (
-        //     $this->feature->allowed(FeatureFlag::USE_PAYMENT_PROCESSOR_FEES)
-        //     && apply_filters(
-        //         'FHEE__EE_Payment_Processor__apply_gateway_partner_fees',
-        //         true,
-        //         $transaction,
-        //         $payment_method,
-        //         $amount
-        //     )
-        // ) {
-        //     $amount = $this->payment_processor_fees->applyGatewayPartnerFees(
-        //         $transaction,
-        //         $payment_method->name(),
-        //         $amount
-        //     );
-        // }
-        // verify payment method type
-        if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            $payment = $payment_method->type_obj()->process_payment(
-                $transaction,
-                $amount,
-                $billing_form,
-                $return_url,
-                add_query_arg(['ee_cancel_payment' => true], $cancel_url),
-                $method,
-                $by_admin
-            );
-            // check if payment method uses an off-site gateway
-            if ($payment_method->type_obj()->payment_occurs() !== EE_PMT_Base::offsite) {
-                // don't process payments for off-site gateways yet because no payment has occurred yet
-                $this->updateTransactionBasedOnPayment($transaction, $payment, $update_txn);
-            }
-            return $payment;
-        }
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    'A valid payment method could not be determined due to a technical issue.%1$sPlease try again or contact %2$s for assistance.',
-                    'event_espresso'
-                ),
-                '<br/>',
-                $this->organization->get_pretty('email')
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return null;
-    }
+	/**
+	 * Using the selected gateway, processes the payment for that transaction, and updates the transaction
+	 * appropriately. Saves the payment that is generated
+	 *
+	 * @param EE_Payment_Method         $payment_method
+	 * @param EE_Transaction            $transaction
+	 * @param EE_Billing_Info_Form|null $billing_form  (or probably null, if it's an offline or offsite payment
+	 *                                                 method).
+	 *                                                 Receive_form_submission() should have
+	 *                                                 already been called on the billing form
+	 *                                                 (ie, its inputs should have their normalized values set).
+	 * @param float                     $amount        if only part of the transaction is to be paid for, how much.
+	 *                                                 Leave null if payment is for the full amount owing
+	 * @param bool                      $by_admin      TRUE if payment is being attempted from the admin
+	 * @param bool                      $update_txn    whether to call EE_Transaction_Processor
+	 *                                                 ::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @param string                    $return_url    string used mostly by offsite gateways to specify
+	 *                                                 where to go AFTER the offsite gateway
+	 * @param string                    $cancel_url    URL to return to if off-site payments are cancelled
+	 * @param string                    $method        like 'CART', indicates who the client who called this was
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 * @throws Exception
+	 * @throws ReflectionException
+	 */
+	public function processPayment(
+		EE_Payment_Method $payment_method,
+		EE_Transaction $transaction,
+		?EE_Billing_Info_Form $billing_form = null,
+		float $amount = 0.00,
+		bool $by_admin = false,
+		bool $update_txn = true,
+		string $return_url = '',
+		string $cancel_url = '',
+		string $method = 'CART'
+	): ?EE_Payment {
+		$this->validatePaymentAmount($transaction, $amount);
+		// verify payment method
+		$payment_method = $this->payment_method_model->ensure_is_obj(
+			$payment_method,
+			true
+		);
+		// verify transaction
+		$this->transaction_model->ensure_is_obj($transaction);
+		$transaction->set_payment_method_ID($payment_method->ID());
+		// make sure we don't overcharge
+		$amount = min($amount, $transaction->remaining());
+		// TODO: add some extra logic to PaymentProcessorFees to designate where/when partner fees are applied based on the PM being used.
+		// if (
+		//     $this->feature->allowed(FeatureFlag::USE_PAYMENT_PROCESSOR_FEES)
+		//     && apply_filters(
+		//         'FHEE__EE_Payment_Processor__apply_gateway_partner_fees',
+		//         true,
+		//         $transaction,
+		//         $payment_method,
+		//         $amount
+		//     )
+		// ) {
+		//     $amount = $this->payment_processor_fees->applyGatewayPartnerFees(
+		//         $transaction,
+		//         $payment_method->name(),
+		//         $amount
+		//     );
+		// }
+		// verify payment method type
+		if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+			$payment = $payment_method->type_obj()->process_payment(
+				$transaction,
+				$amount,
+				$billing_form,
+				$return_url,
+				add_query_arg(['ee_cancel_payment' => true], $cancel_url),
+				$method,
+				$by_admin
+			);
+			// check if payment method uses an off-site gateway
+			if ($payment_method->type_obj()->payment_occurs() !== EE_PMT_Base::offsite) {
+				// don't process payments for off-site gateways yet because no payment has occurred yet
+				$this->updateTransactionBasedOnPayment($transaction, $payment, $update_txn);
+			}
+			return $payment;
+		}
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					'A valid payment method could not be determined due to a technical issue.%1$sPlease try again or contact %2$s for assistance.',
+					'event_espresso'
+				),
+				'<br/>',
+				$this->organization->get_pretty('email')
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return null;
+	}
 
 
-    /**
-     * Processes a direct refund request, saves the payment, and updates the transaction appropriately.
-     *
-     * @param EE_Payment_Method|null $payment_method
-     * @param EE_Payment             $payment_to_refund
-     * @param array                  $refund_info
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function processRefund(
-        ?EE_Payment_Method $payment_method,
-        EE_Payment $payment_to_refund,
-        array $refund_info = []
-    ): EE_Payment {
-        if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj()->supports_sending_refunds()) {
-            $payment_method->type_obj()->process_refund($payment_to_refund, $refund_info);
-            $this->updateTransactionBasedOnPayment(
-                $payment_to_refund->transaction(),
-                $payment_to_refund
-            );
-        }
-        return $payment_to_refund;
-    }
+	/**
+	 * Processes a direct refund request, saves the payment, and updates the transaction appropriately.
+	 *
+	 * @param EE_Payment_Method|null $payment_method
+	 * @param EE_Payment             $payment_to_refund
+	 * @param array                  $refund_info
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function processRefund(
+		?EE_Payment_Method $payment_method,
+		EE_Payment $payment_to_refund,
+		array $refund_info = []
+	): EE_Payment {
+		if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj()->supports_sending_refunds()) {
+			$payment_method->type_obj()->process_refund($payment_to_refund, $refund_info);
+			$this->updateTransactionBasedOnPayment(
+				$payment_to_refund->transaction(),
+				$payment_to_refund
+			);
+		}
+		return $payment_to_refund;
+	}
 
 
-    /**
-     * This should be called each time there may have been an update to a
-     * payment on a transaction (ie, we asked for a payment to process a
-     * payment for a transaction, or we told a payment method about an IPN, or
-     * we told a payment method to
-     * "finalize_payment_for" (a transaction), or we told a payment method to
-     * process a refund. This should handle firing the correct hooks to
-     * indicate
-     * what exactly happened and updating the transaction appropriately). This
-     * could be integrated directly into EE_Transaction upon save, but we want
-     * this logic to be separate from 'normal' plain-jane saving and updating
-     * of transactions and payments, and to be tied to payment processing.
-     * Note: this method DOES NOT save the payment passed into it. It is the responsibility
-     * of previous code to decide whether to save (because the payment passed into
-     * this method might be a temporary, never-to-be-saved payment from an offline gateway,
-     * in which case we only want that payment object for some temporary usage during this request,
-     * but we don't want it to be saved).
-     *
-     * @param EE_Transaction  $transaction
-     * @param EE_Payment|null $payment
-     * @param bool            $update_txn whether to call EE_Transaction_Processor::
-     *                                    update_transaction_and_registrations_after_checkout_or_payment()
-     *                                    (you can save 1 DB query if you know you're going
-     *                                    to save it later instead)
-     * @param bool            $IPN
-     *                                    if processing IPNs or other similar payment
-     *                                    related activities that occur in alternate
-     *                                    requests than the main one that is processing the
-     *                                    TXN, then set this to true to check whether the
-     *                                    TXN is locked before updating
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function updateTransactionBasedOnPayment(
-        EE_Transaction $transaction,
-        ?EE_Payment $payment,
-        bool $update_txn = true,
-        bool $IPN = false
-    ) {
-        $do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__not_successful';
-        /** @type EE_Transaction $transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        // can we freely update the TXN at this moment?
-        if ($IPN && $transaction->is_locked()) {
-            // don't update the transaction at this exact moment
-            // because the TXN is active in another request
-            EE_Cron_Tasks::schedule_update_transaction_with_payment(
-                time(),
-                $transaction->ID(),
-                $payment->ID()
-            );
-        } else {
-            // verify payment and that it has been saved
-            if ($payment instanceof EE_Payment) {
-                $do_action = $this->processRegistrationPayments($transaction, $payment, $do_action);
-                $this->updateTransactionAndPayment($transaction, $payment, $update_txn, $IPN);
-            }
-            // granular hook for others to use.
-            do_action($do_action, $transaction, $payment);
-            do_action('AHEE_log', __CLASS__, __FUNCTION__, $do_action, '$do_action');
-            // global hook for others to use.
-            do_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', $transaction, $payment);
-        }
-    }
+	/**
+	 * This should be called each time there may have been an update to a
+	 * payment on a transaction (ie, we asked for a payment to process a
+	 * payment for a transaction, or we told a payment method about an IPN, or
+	 * we told a payment method to
+	 * "finalize_payment_for" (a transaction), or we told a payment method to
+	 * process a refund. This should handle firing the correct hooks to
+	 * indicate
+	 * what exactly happened and updating the transaction appropriately). This
+	 * could be integrated directly into EE_Transaction upon save, but we want
+	 * this logic to be separate from 'normal' plain-jane saving and updating
+	 * of transactions and payments, and to be tied to payment processing.
+	 * Note: this method DOES NOT save the payment passed into it. It is the responsibility
+	 * of previous code to decide whether to save (because the payment passed into
+	 * this method might be a temporary, never-to-be-saved payment from an offline gateway,
+	 * in which case we only want that payment object for some temporary usage during this request,
+	 * but we don't want it to be saved).
+	 *
+	 * @param EE_Transaction  $transaction
+	 * @param EE_Payment|null $payment
+	 * @param bool            $update_txn whether to call EE_Transaction_Processor::
+	 *                                    update_transaction_and_registrations_after_checkout_or_payment()
+	 *                                    (you can save 1 DB query if you know you're going
+	 *                                    to save it later instead)
+	 * @param bool            $IPN
+	 *                                    if processing IPNs or other similar payment
+	 *                                    related activities that occur in alternate
+	 *                                    requests than the main one that is processing the
+	 *                                    TXN, then set this to true to check whether the
+	 *                                    TXN is locked before updating
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function updateTransactionBasedOnPayment(
+		EE_Transaction $transaction,
+		?EE_Payment $payment,
+		bool $update_txn = true,
+		bool $IPN = false
+	) {
+		$do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__not_successful';
+		/** @type EE_Transaction $transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		// can we freely update the TXN at this moment?
+		if ($IPN && $transaction->is_locked()) {
+			// don't update the transaction at this exact moment
+			// because the TXN is active in another request
+			EE_Cron_Tasks::schedule_update_transaction_with_payment(
+				time(),
+				$transaction->ID(),
+				$payment->ID()
+			);
+		} else {
+			// verify payment and that it has been saved
+			if ($payment instanceof EE_Payment) {
+				$do_action = $this->processRegistrationPayments($transaction, $payment, $do_action);
+				$this->updateTransactionAndPayment($transaction, $payment, $update_txn, $IPN);
+			}
+			// granular hook for others to use.
+			do_action($do_action, $transaction, $payment);
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $do_action, '$do_action');
+			// global hook for others to use.
+			do_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', $transaction, $payment);
+		}
+	}
 
 
-    /**
-     * @param EE_Transaction  $transaction
-     * @param EE_Payment $payment
-     * @param string          $do_action
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function processRegistrationPayments(
-        EE_Transaction $transaction,
-        EE_Payment $payment,
-        string $do_action
-    ): string {
-        if ($payment->ID()) {
-            if (
-                $payment->payment_method() instanceof EE_Payment_Method
-                && $payment->payment_method()->type_obj() instanceof EE_PMT_Base
-            ) {
-                $payment->payment_method()->type_obj()->update_txn_based_on_payment($payment);
-                // update TXN registrations with payment info
-                $this->registration_payments->processRegistrationPayments($transaction, $payment);
-            }
-            return $payment->just_approved()
-                ? 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__successful'
-                : $do_action;
-        }
-        // send out notifications
-        add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-        return 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__no_payment_made';
-    }
+	/**
+	 * @param EE_Transaction  $transaction
+	 * @param EE_Payment $payment
+	 * @param string          $do_action
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function processRegistrationPayments(
+		EE_Transaction $transaction,
+		EE_Payment $payment,
+		string $do_action
+	): string {
+		if ($payment->ID()) {
+			if (
+				$payment->payment_method() instanceof EE_Payment_Method
+				&& $payment->payment_method()->type_obj() instanceof EE_PMT_Base
+			) {
+				$payment->payment_method()->type_obj()->update_txn_based_on_payment($payment);
+				// update TXN registrations with payment info
+				$this->registration_payments->processRegistrationPayments($transaction, $payment);
+			}
+			return $payment->just_approved()
+				? 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__successful'
+				: $do_action;
+		}
+		// send out notifications
+		add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+		return 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__no_payment_made';
+	}
 
 
-    /**
-     * @param EE_Transaction $transaction
-     * @param EE_Payment     $payment
-     * @param bool           $update_txn
-     * @param bool           $IPN
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updateTransactionAndPayment(
-        EE_Transaction $transaction,
-        EE_Payment $payment,
-        bool $update_txn,
-        bool $IPN
-    ) {
-        if ($payment->status() !== EEM_Payment::status_id_failed) {
-            /** @type EE_Transaction_Payments $transaction_payments */
-            $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-            // set new value for total paid
-            $transaction_payments->calculate_total_payments_and_update_status($transaction);
-            if ($update_txn) {
-                $this->post_payment_processor->updateTransactionAndPayment($transaction, $payment, $IPN);
-            }
-        }
-    }
+	/**
+	 * @param EE_Transaction $transaction
+	 * @param EE_Payment     $payment
+	 * @param bool           $update_txn
+	 * @param bool           $IPN
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updateTransactionAndPayment(
+		EE_Transaction $transaction,
+		EE_Payment $payment,
+		bool $update_txn,
+		bool $IPN
+	) {
+		if ($payment->status() !== EEM_Payment::status_id_failed) {
+			/** @type EE_Transaction_Payments $transaction_payments */
+			$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+			// set new value for total paid
+			$transaction_payments->calculate_total_payments_and_update_status($transaction);
+			if ($update_txn) {
+				$this->post_payment_processor->updateTransactionAndPayment($transaction, $payment, $IPN);
+			}
+		}
+	}
 
 
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function validatePaymentAmount(EE_Transaction $transaction, float $amount)
-    {
-        if ($amount < 0) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Attempting to make a payment for a negative amount of %1$d for transaction %2$d. That should be a refund',
-                        'event_espresso'
-                    ),
-                    $amount,
-                    $transaction->ID()
-                )
-            );
-        }
-    }
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function validatePaymentAmount(EE_Transaction $transaction, float $amount)
+	{
+		if ($amount < 0) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Attempting to make a payment for a negative amount of %1$d for transaction %2$d. That should be a refund',
+						'event_espresso'
+					),
+					$amount,
+					$transaction->ID()
+				)
+			);
+		}
+	}
 }

core/services/payments/IpnHandler.php

Indentation +374 added lines, -374 removed lines

@@ -32,378 +32,378 @@
  */
 class IpnHandler
 {
-    private EEM_Payment_Method $payment_method_model;
-
-    private EEM_Transaction $transaction_model;
-
-    private EE_Core_Config $core_config;
-
-    private EE_Organization_Config $organization;
-
-    private PaymentProcessor $payment_processor;
-
-
-    /**
-     * @param EEM_Payment_Method $payment_method_model
-     * @param EEM_Transaction $transaction_model
-     * @param EE_Core_Config $core_config
-     * @param EE_Organization_Config $organization
-     * @param PaymentProcessor $payment_processor
-     */
-    public function __construct(
-        EEM_Payment_Method $payment_method_model,
-        EEM_Transaction $transaction_model,
-        EE_Core_Config $core_config,
-        EE_Organization_Config $organization,
-        PaymentProcessor $payment_processor
-    ) {
-        $this->payment_method_model = $payment_method_model;
-        $this->transaction_model    = $transaction_model;
-        $this->core_config          = $core_config;
-        $this->organization         = $organization;
-        $this->payment_processor    = $payment_processor;
-    }
-
-
-    /**
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment_Method $payment_method
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getIpnUrlForPaymentMethod(EE_Transaction $transaction, EE_Payment_Method $payment_method): string
-    {
-        $primary_reg = $transaction->primary_registration();
-        if (! $primary_reg instanceof EE_Registration) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Cannot get IPN URL for transaction with ID %d because it has no primary registration',
-                        'event_espresso'
-                    ),
-                    $transaction->ID()
-                )
-            );
-        }
-        $payment_method = $this->payment_method_model->ensure_is_obj(
-            $payment_method,
-            true
-        );
-        return add_query_arg(
-            [
-                'e_reg_url_link'    => $primary_reg->reg_url_link(),
-                'ee_payment_method' => $payment_method->slug(),
-            ],
-            $this->core_config->txn_page_url()
-        );
-    }
-
-
-    /**
-     * Process the IPN. Firstly, we'll hope we put the standard args into the IPN URL so
-     * we can easily find what registration the IPN is for and what payment method.
-     * However, if not, we'll give all payment methods a chance to claim it and process it.
-     * If a payment is found for the IPN info, it is saved.
-     *
-     * @param array                             $request_data         form post data
-     * @param EE_Transaction|int|null           $transaction          optional (or a transaction's id)
-     * @param EE_Payment_Method|int|string|null $payment_method       optional (or a slug or id of PM)
-     * @param bool                              $update_txn           whether to call
-     *                                                                EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @param bool                              $separate_IPN_request whether the IPN uses a separate request (true,
-     *                                                                like PayPal) or is processed manually (false,
-     *                                                                like Authorize.net)
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function processIPN(
-        array $request_data,
-        $transaction = null,
-        $payment_method = null,
-        bool $update_txn = true,
-        bool $separate_IPN_request = true
-    ): EE_Payment {
-        $request_data = $this->removeUnusableCharactersFromArray($request_data);
-        EE_Processor_Base::set_IPN($separate_IPN_request);
-        ['log' => $log, 'object' => $log_object] = $this->logIPN($request_data, $transaction, $payment_method);
-
-        try {
-            if ($transaction && $payment_method) {
-                $payment = $this->processStandardIPN($request_data, $log, $log_object, $transaction, $payment_method);
-            } else {
-                ['payment' => $payment, 'payment_method' => $payment_method] = $this->processWaywardIPN(
-                    $request_data,
-                    $log_object
-                );
-            }
-            return $this->postIpnProcessing(
-                $payment,
-                $request_data,
-                $update_txn,
-                $separate_IPN_request,
-                $transaction,
-                $payment_method
-            );
-        } catch (EE_Error $exception) {
-            $this->invalidIpnException($exception, $transaction, $request_data);
-        }
-    }
-
-
-    /**
-     * @param array                             $request_data
-     * @param EE_Change_Log                     $log
-     * @param EE_Base_Class|null                $log_object
-     * @param EE_Transaction|int|null           $transaction    optional (model object or a transaction's id)
-     * @param EE_Payment_Method|int|string|null $payment_method optional (model object or a slug or id of PM)
-     * @return EE_Payment|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function processStandardIPN(
-        array $request_data,
-        EE_Change_Log $log,
-        ?EE_Base_Class $log_object,
-        $transaction = null,
-        $payment_method = null
-    ): ?EE_Payment {
-        /** @type EE_Transaction $transaction */
-        $transaction = $this->transaction_model->ensure_is_obj($transaction);
-        /** @type EE_Payment_Method $payment_method */
-        $payment_method = $this->payment_method_model->ensure_is_obj($payment_method);
-        if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
-            // not a payment
-            $this->invalidPaymentError();
-            return null;
-        }
-        try {
-            $payment = $payment_method->type_obj()->handle_ipn($request_data, $transaction);
-            $log->set_object($payment);
-            return $payment;
-        } catch (IpnException $exception) {
-            $payment = $this->logIpnException($exception, $log_object);
-        }
-        return $payment;
-    }
-
-
-    /**
-     * @param array              $request_data
-     * @param EE_Base_Class|null $log_object
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function processWaywardIPN(
-        array $request_data,
-        ?EE_Base_Class $log_object
-    ): array {
-        $payment        = null;
-        $payment_method = null;
-        // that's actually pretty ok. The IPN just wasn't able
-        // to identify which transaction or payment method this was for
-        // give all active payment methods a chance to claim it
-        $active_payment_methods = $this->payment_method_model->get_all_active();
-        foreach ($active_payment_methods as $payment_method) {
-            try {
-                $pm_type = $payment_method->type_obj();
-                $payment = $pm_type instanceof EE_PMT_Base ? $pm_type->handle_unclaimed_ipn($request_data) : $payment;
-                $this->logIpnData(['IPN data' => $request_data], $payment);
-                break;
-            } catch (IpnException $exception) {
-                $payment = $this->logIpnException($exception, $log_object);
-            } catch (EE_Error $e) {
-                // that's fine- it apparently couldn't handle the IPN
-            }
-        }
-        return [$payment, $payment_method];
-    }
-
-
-    /**
-     * @param EE_Payment|null                   $payment
-     * @param array                             $request_data
-     * @param bool                              $update_txn
-     * @param bool                              $separate_IPN_request
-     * @param EE_Transaction|int|null           $transaction    optional (model object or a transaction's id)
-     * @param EE_Payment_Method|int|string|null $payment_method optional (model object or a slug or id of PM)
-     * @return EE_Payment|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function postIpnProcessing(
-        ?EE_Payment $payment,
-        array $request_data,
-        bool $update_txn,
-        bool $separate_IPN_request,
-        $transaction = null,
-        $payment_method = null
-    ): ?EE_Payment {
-        if ($payment instanceof EE_Payment) {
-            $payment->save();
-            $this->payment_processor->updateTransactionBasedOnPayment(
-                $transaction,
-                $payment,
-                $update_txn,
-                $separate_IPN_request
-            );
-        } else {
-            // we couldn't find the payment for this IPN... let's try and log at least SOMETHING
-            if ($payment_method) {
-                $this->logIpnData(['IPN data' => $request_data], $payment_method);
-            } elseif ($transaction) {
-                $this->logIpnData(['IPN data' => $request_data], $transaction);
-            }
-        }
-        return $payment;
-    }
-
-
-    /**
-     * @param array                             $request_data
-     * @param EE_Transaction|int|null           $transaction    optional (model object or a transaction's id)
-     * @param EE_Payment_Method|int|string|null $payment_method optional (model object or a slug or id of PM)
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function logIPN(
-        array $request_data,
-        $transaction = null,
-        $payment_method = null
-    ): array {
-        $log_object = null;
-        if ($transaction instanceof EE_Transaction) {
-            $log_object = $transaction;
-            if ($payment_method instanceof EE_Payment_Method) {
-                $log_object = EEM_Payment::instance()->get_one(
-                    [
-                        ['TXN_ID' => $transaction->ID(), 'PMD_ID' => $payment_method->ID()],
-                        'order_by' => ['PAY_timestamp' => 'desc'],
-                    ]
-                );
-            }
-        }
-        $log = $this->logIpnData(['IPN data received' => $request_data], $log_object);
-        return [
-            'log'    => $log,
-            'object' => $log_object,
-        ];
-    }
-
-
-    /**
-     * @param array              $data
-     * @param EE_Base_Class|null $log_object
-     * @return EE_Change_Log
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function logIpnData(array $data, ?EE_Base_Class $log_object): EE_Change_Log
-    {
-        return EEM_Change_Log::instance()->log(EEM_Change_Log::type_gateway, $data, $log_object);
-    }
-
-
-    /**
-     * @param IpnException       $exception
-     * @param EE_Base_Class|null $log_object
-     * @return EE_Payment|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function logIpnException(IpnException $exception, ?EE_Base_Class $log_object): ?EE_Payment
-    {
-        $this->logIpnData(
-            [
-                'message'     => 'IPN Exception: ' . $exception->getMessage(),
-                'current_url' => EEH_URL::current_url(),
-                'payment'     => $exception->getPaymentProperties(),
-                'IPN_data'    => $exception->getIpnData(),
-            ],
-            $log_object
-        );
-        return $exception->getPayment();
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    private function invalidPaymentError()
-    {
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    'A valid payment method could not be determined due to a technical issue.%1$sPlease refresh your browser and try again or contact %2$s for assistance.',
-                    'event_espresso'
-                ),
-                '<br/>',
-                $this->organization->get_pretty('email')
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-    }
-
-
-    /**
-     * @param Exception $exception
-     * @param           $transaction
-     * @param           $request_data
-     * @return mixed
-     * @throws Exception
-     */
-    private function invalidIpnException(Exception $exception, $transaction, $request_data)
-    {
-        do_action(
-            'AHEE__log',
-            __FILE__,
-            __FUNCTION__,
-            sprintf(
-                esc_html__(
-                    'Error occurred while receiving IPN. Transaction: %1$s, req data: %2$s. The error was "%3$s"',
-                    'event_espresso'
-                ),
-                print_r($transaction, true),
-                print_r($request_data, true),
-                $exception->getMessage()
-            )
-        );
-        throw $exception;
-    }
-
-
-    /**
-     * Removes any non-printable illegal characters from the input,
-     * which might cause a raucous when trying to insert into the database
-     *
-     * @param array $request_data
-     * @return array
-     */
-    private function removeUnusableCharactersFromArray(array $request_data): array
-    {
-        $return_data = [];
-        foreach ($request_data as $key => $value) {
-            $return_data[ $this->removeUnusableCharacters($key) ] = $this->removeUnusableCharacters($value);
-        }
-        return $return_data;
-    }
-
-
-    /**
-     * Removes any non-printable illegal characters from the input,
-     * which might cause a raucous when trying to insert into the database
-     *
-     * @param string $request_data
-     * @return string
-     */
-    private function removeUnusableCharacters(string $request_data): string
-    {
-        return preg_replace('/[^[:print:]]/', '', $request_data);
-    }
+	private EEM_Payment_Method $payment_method_model;
+
+	private EEM_Transaction $transaction_model;
+
+	private EE_Core_Config $core_config;
+
+	private EE_Organization_Config $organization;
+
+	private PaymentProcessor $payment_processor;
+
+
+	/**
+	 * @param EEM_Payment_Method $payment_method_model
+	 * @param EEM_Transaction $transaction_model
+	 * @param EE_Core_Config $core_config
+	 * @param EE_Organization_Config $organization
+	 * @param PaymentProcessor $payment_processor
+	 */
+	public function __construct(
+		EEM_Payment_Method $payment_method_model,
+		EEM_Transaction $transaction_model,
+		EE_Core_Config $core_config,
+		EE_Organization_Config $organization,
+		PaymentProcessor $payment_processor
+	) {
+		$this->payment_method_model = $payment_method_model;
+		$this->transaction_model    = $transaction_model;
+		$this->core_config          = $core_config;
+		$this->organization         = $organization;
+		$this->payment_processor    = $payment_processor;
+	}
+
+
+	/**
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment_Method $payment_method
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getIpnUrlForPaymentMethod(EE_Transaction $transaction, EE_Payment_Method $payment_method): string
+	{
+		$primary_reg = $transaction->primary_registration();
+		if (! $primary_reg instanceof EE_Registration) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Cannot get IPN URL for transaction with ID %d because it has no primary registration',
+						'event_espresso'
+					),
+					$transaction->ID()
+				)
+			);
+		}
+		$payment_method = $this->payment_method_model->ensure_is_obj(
+			$payment_method,
+			true
+		);
+		return add_query_arg(
+			[
+				'e_reg_url_link'    => $primary_reg->reg_url_link(),
+				'ee_payment_method' => $payment_method->slug(),
+			],
+			$this->core_config->txn_page_url()
+		);
+	}
+
+
+	/**
+	 * Process the IPN. Firstly, we'll hope we put the standard args into the IPN URL so
+	 * we can easily find what registration the IPN is for and what payment method.
+	 * However, if not, we'll give all payment methods a chance to claim it and process it.
+	 * If a payment is found for the IPN info, it is saved.
+	 *
+	 * @param array                             $request_data         form post data
+	 * @param EE_Transaction|int|null           $transaction          optional (or a transaction's id)
+	 * @param EE_Payment_Method|int|string|null $payment_method       optional (or a slug or id of PM)
+	 * @param bool                              $update_txn           whether to call
+	 *                                                                EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @param bool                              $separate_IPN_request whether the IPN uses a separate request (true,
+	 *                                                                like PayPal) or is processed manually (false,
+	 *                                                                like Authorize.net)
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function processIPN(
+		array $request_data,
+		$transaction = null,
+		$payment_method = null,
+		bool $update_txn = true,
+		bool $separate_IPN_request = true
+	): EE_Payment {
+		$request_data = $this->removeUnusableCharactersFromArray($request_data);
+		EE_Processor_Base::set_IPN($separate_IPN_request);
+		['log' => $log, 'object' => $log_object] = $this->logIPN($request_data, $transaction, $payment_method);
+
+		try {
+			if ($transaction && $payment_method) {
+				$payment = $this->processStandardIPN($request_data, $log, $log_object, $transaction, $payment_method);
+			} else {
+				['payment' => $payment, 'payment_method' => $payment_method] = $this->processWaywardIPN(
+					$request_data,
+					$log_object
+				);
+			}
+			return $this->postIpnProcessing(
+				$payment,
+				$request_data,
+				$update_txn,
+				$separate_IPN_request,
+				$transaction,
+				$payment_method
+			);
+		} catch (EE_Error $exception) {
+			$this->invalidIpnException($exception, $transaction, $request_data);
+		}
+	}
+
+
+	/**
+	 * @param array                             $request_data
+	 * @param EE_Change_Log                     $log
+	 * @param EE_Base_Class|null                $log_object
+	 * @param EE_Transaction|int|null           $transaction    optional (model object or a transaction's id)
+	 * @param EE_Payment_Method|int|string|null $payment_method optional (model object or a slug or id of PM)
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function processStandardIPN(
+		array $request_data,
+		EE_Change_Log $log,
+		?EE_Base_Class $log_object,
+		$transaction = null,
+		$payment_method = null
+	): ?EE_Payment {
+		/** @type EE_Transaction $transaction */
+		$transaction = $this->transaction_model->ensure_is_obj($transaction);
+		/** @type EE_Payment_Method $payment_method */
+		$payment_method = $this->payment_method_model->ensure_is_obj($payment_method);
+		if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
+			// not a payment
+			$this->invalidPaymentError();
+			return null;
+		}
+		try {
+			$payment = $payment_method->type_obj()->handle_ipn($request_data, $transaction);
+			$log->set_object($payment);
+			return $payment;
+		} catch (IpnException $exception) {
+			$payment = $this->logIpnException($exception, $log_object);
+		}
+		return $payment;
+	}
+
+
+	/**
+	 * @param array              $request_data
+	 * @param EE_Base_Class|null $log_object
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function processWaywardIPN(
+		array $request_data,
+		?EE_Base_Class $log_object
+	): array {
+		$payment        = null;
+		$payment_method = null;
+		// that's actually pretty ok. The IPN just wasn't able
+		// to identify which transaction or payment method this was for
+		// give all active payment methods a chance to claim it
+		$active_payment_methods = $this->payment_method_model->get_all_active();
+		foreach ($active_payment_methods as $payment_method) {
+			try {
+				$pm_type = $payment_method->type_obj();
+				$payment = $pm_type instanceof EE_PMT_Base ? $pm_type->handle_unclaimed_ipn($request_data) : $payment;
+				$this->logIpnData(['IPN data' => $request_data], $payment);
+				break;
+			} catch (IpnException $exception) {
+				$payment = $this->logIpnException($exception, $log_object);
+			} catch (EE_Error $e) {
+				// that's fine- it apparently couldn't handle the IPN
+			}
+		}
+		return [$payment, $payment_method];
+	}
+
+
+	/**
+	 * @param EE_Payment|null                   $payment
+	 * @param array                             $request_data
+	 * @param bool                              $update_txn
+	 * @param bool                              $separate_IPN_request
+	 * @param EE_Transaction|int|null           $transaction    optional (model object or a transaction's id)
+	 * @param EE_Payment_Method|int|string|null $payment_method optional (model object or a slug or id of PM)
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function postIpnProcessing(
+		?EE_Payment $payment,
+		array $request_data,
+		bool $update_txn,
+		bool $separate_IPN_request,
+		$transaction = null,
+		$payment_method = null
+	): ?EE_Payment {
+		if ($payment instanceof EE_Payment) {
+			$payment->save();
+			$this->payment_processor->updateTransactionBasedOnPayment(
+				$transaction,
+				$payment,
+				$update_txn,
+				$separate_IPN_request
+			);
+		} else {
+			// we couldn't find the payment for this IPN... let's try and log at least SOMETHING
+			if ($payment_method) {
+				$this->logIpnData(['IPN data' => $request_data], $payment_method);
+			} elseif ($transaction) {
+				$this->logIpnData(['IPN data' => $request_data], $transaction);
+			}
+		}
+		return $payment;
+	}
+
+
+	/**
+	 * @param array                             $request_data
+	 * @param EE_Transaction|int|null           $transaction    optional (model object or a transaction's id)
+	 * @param EE_Payment_Method|int|string|null $payment_method optional (model object or a slug or id of PM)
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function logIPN(
+		array $request_data,
+		$transaction = null,
+		$payment_method = null
+	): array {
+		$log_object = null;
+		if ($transaction instanceof EE_Transaction) {
+			$log_object = $transaction;
+			if ($payment_method instanceof EE_Payment_Method) {
+				$log_object = EEM_Payment::instance()->get_one(
+					[
+						['TXN_ID' => $transaction->ID(), 'PMD_ID' => $payment_method->ID()],
+						'order_by' => ['PAY_timestamp' => 'desc'],
+					]
+				);
+			}
+		}
+		$log = $this->logIpnData(['IPN data received' => $request_data], $log_object);
+		return [
+			'log'    => $log,
+			'object' => $log_object,
+		];
+	}
+
+
+	/**
+	 * @param array              $data
+	 * @param EE_Base_Class|null $log_object
+	 * @return EE_Change_Log
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function logIpnData(array $data, ?EE_Base_Class $log_object): EE_Change_Log
+	{
+		return EEM_Change_Log::instance()->log(EEM_Change_Log::type_gateway, $data, $log_object);
+	}
+
+
+	/**
+	 * @param IpnException       $exception
+	 * @param EE_Base_Class|null $log_object
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function logIpnException(IpnException $exception, ?EE_Base_Class $log_object): ?EE_Payment
+	{
+		$this->logIpnData(
+			[
+				'message'     => 'IPN Exception: ' . $exception->getMessage(),
+				'current_url' => EEH_URL::current_url(),
+				'payment'     => $exception->getPaymentProperties(),
+				'IPN_data'    => $exception->getIpnData(),
+			],
+			$log_object
+		);
+		return $exception->getPayment();
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function invalidPaymentError()
+	{
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					'A valid payment method could not be determined due to a technical issue.%1$sPlease refresh your browser and try again or contact %2$s for assistance.',
+					'event_espresso'
+				),
+				'<br/>',
+				$this->organization->get_pretty('email')
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+	}
+
+
+	/**
+	 * @param Exception $exception
+	 * @param           $transaction
+	 * @param           $request_data
+	 * @return mixed
+	 * @throws Exception
+	 */
+	private function invalidIpnException(Exception $exception, $transaction, $request_data)
+	{
+		do_action(
+			'AHEE__log',
+			__FILE__,
+			__FUNCTION__,
+			sprintf(
+				esc_html__(
+					'Error occurred while receiving IPN. Transaction: %1$s, req data: %2$s. The error was "%3$s"',
+					'event_espresso'
+				),
+				print_r($transaction, true),
+				print_r($request_data, true),
+				$exception->getMessage()
+			)
+		);
+		throw $exception;
+	}
+
+
+	/**
+	 * Removes any non-printable illegal characters from the input,
+	 * which might cause a raucous when trying to insert into the database
+	 *
+	 * @param array $request_data
+	 * @return array
+	 */
+	private function removeUnusableCharactersFromArray(array $request_data): array
+	{
+		$return_data = [];
+		foreach ($request_data as $key => $value) {
+			$return_data[ $this->removeUnusableCharacters($key) ] = $this->removeUnusableCharacters($value);
+		}
+		return $return_data;
+	}
+
+
+	/**
+	 * Removes any non-printable illegal characters from the input,
+	 * which might cause a raucous when trying to insert into the database
+	 *
+	 * @param string $request_data
+	 * @return string
+	 */
+	private function removeUnusableCharacters(string $request_data): string
+	{
+		return preg_replace('/[^[:print:]]/', '', $request_data);
+	}
 }

core/services/payments/PaymentProcessorFees.php

Indentation +158 added lines, -158 removed lines

@@ -28,162 +28,162 @@
  */
 class PaymentProcessorFees
 {
-    public const  GATEWAY_PAYPAL  = 'PayPal Commerce';
-
-    public const  GATEWAY_SQUARE  = 'Square';
-
-    public const  GATEWAY_STRIPE  = 'Stripe';
-
-    private GracePeriod $grace_period;
-
-    private LicenseData $license_data;
-
-    /**
-     * @var float[][] $gateway_fees
-     */
-    private array $gateway_fees = [
-        LicenseData::LICENSE_ACTIVE  => [
-            PaymentProcessorFees::GATEWAY_PAYPAL => 0.00,
-            PaymentProcessorFees::GATEWAY_SQUARE => 0.00,
-            PaymentProcessorFees::GATEWAY_STRIPE => 0.00,
-        ],
-        LicenseData::LICENSE_EXPIRED => [
-            PaymentProcessorFees::GATEWAY_PAYPAL => 3.00,
-            PaymentProcessorFees::GATEWAY_SQUARE => 2.50,
-            PaymentProcessorFees::GATEWAY_STRIPE => 2.50,
-        ],
-        LicenseData::LICENSE_DECAF   => [
-            PaymentProcessorFees::GATEWAY_PAYPAL => 3.00,
-            PaymentProcessorFees::GATEWAY_SQUARE => 2.50,
-            PaymentProcessorFees::GATEWAY_STRIPE => 2.50,
-        ],
-    ];
-
-    private array $partner_gateways = [
-        PaymentProcessorFees::GATEWAY_PAYPAL,
-        PaymentProcessorFees::GATEWAY_SQUARE,
-        PaymentProcessorFees::GATEWAY_STRIPE,
-    ];
-
-
-    /**
-     * @param GracePeriod $grace_period
-     * @param LicenseData $license_data
-     */
-    public function __construct(GracePeriod $grace_period, LicenseData $license_data)
-    {
-        $this->grace_period = $grace_period;
-        $this->license_data = $license_data;
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @param string         $payment_method_name
-     * @param float          $amount
-     * @return float
-     * @throws EE_Error|ReflectionException|RuntimeException
-     * @throws Exception
-     */
-    public function applyGatewayPartnerFees(
-        EE_Transaction $transaction,
-        string $payment_method_name,
-        float $amount = 0.00
-    ): float {
-        $processing_fee = $this->forPaymentMethod($payment_method_name);
-        if ($processing_fee <= 0.00) {
-            return $amount;
-        }
-        $grand_total = $transaction->total_line_item(false);
-        if (
-            ! $grand_total instanceof EE_Line_Item
-            || ! $grand_total->is_total()
-            || $grand_total->TXN_ID() !== $transaction->ID()
-        ) {
-            // throw RuntimeException if total_line_item is not a total line item
-            throw new RuntimeException(
-                sprintf(
-                    esc_html__(
-                        'Invalid or missing grand total line item for transaction %1$d.',
-                        'event_espresso'
-                    ),
-                    $transaction->ID()
-                )
-            );
-        }
-        $line_item = EEH_Line_Item::add_percentage_based_item(
-            EEH_Line_Item::get_pre_tax_subtotal($grand_total),
-            esc_html__('Payment Processing Fee', 'event_espresso'),
-            $processing_fee,
-            '',
-            false,
-            sanitize_key(
-                sprintf(
-                    '%1$s-fee-%2$d',
-                    $payment_method_name,
-                    $transaction->ID()
-                )
-            ),
-            true
-        );
-        $line_item->save();
-        return $grand_total->recalculate_total_including_taxes();
-    }
-
-
-    /**
-     * Returns the fee for a specific payment method based on the license status.
-     *
-     * @param string $payment_method_name
-     * @return float
-     * @throws Exception|OutOfBoundsException|RuntimeException
-     */
-    public function forPaymentMethod(string $payment_method_name): float
-    {
-        if (! $this->isPartnerGateway($payment_method_name)) {
-            return 0.0;
-        }
-        $license_status = $this->license_data->licenseStatus();
-        $license_expires = $this->license_data->licenseExpiry();
-        // decaf, new activations, or expired licenses are allowed a grace period
-        if ($this->grace_period->withinGracePeriod($license_status, $license_expires)) {
-            return 0.0;
-        }
-        return $this->getGatewayFee($payment_method_name, $license_status);
-    }
-
-
-    /**
-     * Checks if a gateway is a partner gateway.
-     *
-     * @param string $payment_method_name
-     * @return bool
-     */
-    private function isPartnerGateway(string $payment_method_name): bool
-    {
-        return in_array($payment_method_name, $this->partner_gateways, true);
-    }
-
-
-    /**
-     * Returns the fee for a specific payment method based on the license status.
-     *
-     * @param string $payment_method_name
-     * @param string $license_status
-     * @return float
-     * @throws OutOfBoundsException
-     */
-    private function getGatewayFee(string $payment_method_name, string $license_status): float
-    {
-        if (isset($this->gateway_fees[ $license_status ][ $payment_method_name ])) {
-            return $this->gateway_fees[ $license_status ][ $payment_method_name ];
-        }
-        throw new OutOfBoundsException(
-            sprintf(
-                esc_html__('A partner fee for %1$s with %2$s license is not defined.', 'event_espresso'),
-                $payment_method_name,
-                $license_status
-            )
-        );
-    }
+	public const  GATEWAY_PAYPAL  = 'PayPal Commerce';
+
+	public const  GATEWAY_SQUARE  = 'Square';
+
+	public const  GATEWAY_STRIPE  = 'Stripe';
+
+	private GracePeriod $grace_period;
+
+	private LicenseData $license_data;
+
+	/**
+	 * @var float[][] $gateway_fees
+	 */
+	private array $gateway_fees = [
+		LicenseData::LICENSE_ACTIVE  => [
+			PaymentProcessorFees::GATEWAY_PAYPAL => 0.00,
+			PaymentProcessorFees::GATEWAY_SQUARE => 0.00,
+			PaymentProcessorFees::GATEWAY_STRIPE => 0.00,
+		],
+		LicenseData::LICENSE_EXPIRED => [
+			PaymentProcessorFees::GATEWAY_PAYPAL => 3.00,
+			PaymentProcessorFees::GATEWAY_SQUARE => 2.50,
+			PaymentProcessorFees::GATEWAY_STRIPE => 2.50,
+		],
+		LicenseData::LICENSE_DECAF   => [
+			PaymentProcessorFees::GATEWAY_PAYPAL => 3.00,
+			PaymentProcessorFees::GATEWAY_SQUARE => 2.50,
+			PaymentProcessorFees::GATEWAY_STRIPE => 2.50,
+		],
+	];
+
+	private array $partner_gateways = [
+		PaymentProcessorFees::GATEWAY_PAYPAL,
+		PaymentProcessorFees::GATEWAY_SQUARE,
+		PaymentProcessorFees::GATEWAY_STRIPE,
+	];
+
+
+	/**
+	 * @param GracePeriod $grace_period
+	 * @param LicenseData $license_data
+	 */
+	public function __construct(GracePeriod $grace_period, LicenseData $license_data)
+	{
+		$this->grace_period = $grace_period;
+		$this->license_data = $license_data;
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @param string         $payment_method_name
+	 * @param float          $amount
+	 * @return float
+	 * @throws EE_Error|ReflectionException|RuntimeException
+	 * @throws Exception
+	 */
+	public function applyGatewayPartnerFees(
+		EE_Transaction $transaction,
+		string $payment_method_name,
+		float $amount = 0.00
+	): float {
+		$processing_fee = $this->forPaymentMethod($payment_method_name);
+		if ($processing_fee <= 0.00) {
+			return $amount;
+		}
+		$grand_total = $transaction->total_line_item(false);
+		if (
+			! $grand_total instanceof EE_Line_Item
+			|| ! $grand_total->is_total()
+			|| $grand_total->TXN_ID() !== $transaction->ID()
+		) {
+			// throw RuntimeException if total_line_item is not a total line item
+			throw new RuntimeException(
+				sprintf(
+					esc_html__(
+						'Invalid or missing grand total line item for transaction %1$d.',
+						'event_espresso'
+					),
+					$transaction->ID()
+				)
+			);
+		}
+		$line_item = EEH_Line_Item::add_percentage_based_item(
+			EEH_Line_Item::get_pre_tax_subtotal($grand_total),
+			esc_html__('Payment Processing Fee', 'event_espresso'),
+			$processing_fee,
+			'',
+			false,
+			sanitize_key(
+				sprintf(
+					'%1$s-fee-%2$d',
+					$payment_method_name,
+					$transaction->ID()
+				)
+			),
+			true
+		);
+		$line_item->save();
+		return $grand_total->recalculate_total_including_taxes();
+	}
+
+
+	/**
+	 * Returns the fee for a specific payment method based on the license status.
+	 *
+	 * @param string $payment_method_name
+	 * @return float
+	 * @throws Exception|OutOfBoundsException|RuntimeException
+	 */
+	public function forPaymentMethod(string $payment_method_name): float
+	{
+		if (! $this->isPartnerGateway($payment_method_name)) {
+			return 0.0;
+		}
+		$license_status = $this->license_data->licenseStatus();
+		$license_expires = $this->license_data->licenseExpiry();
+		// decaf, new activations, or expired licenses are allowed a grace period
+		if ($this->grace_period->withinGracePeriod($license_status, $license_expires)) {
+			return 0.0;
+		}
+		return $this->getGatewayFee($payment_method_name, $license_status);
+	}
+
+
+	/**
+	 * Checks if a gateway is a partner gateway.
+	 *
+	 * @param string $payment_method_name
+	 * @return bool
+	 */
+	private function isPartnerGateway(string $payment_method_name): bool
+	{
+		return in_array($payment_method_name, $this->partner_gateways, true);
+	}
+
+
+	/**
+	 * Returns the fee for a specific payment method based on the license status.
+	 *
+	 * @param string $payment_method_name
+	 * @param string $license_status
+	 * @return float
+	 * @throws OutOfBoundsException
+	 */
+	private function getGatewayFee(string $payment_method_name, string $license_status): float
+	{
+		if (isset($this->gateway_fees[ $license_status ][ $payment_method_name ])) {
+			return $this->gateway_fees[ $license_status ][ $payment_method_name ];
+		}
+		throw new OutOfBoundsException(
+			sprintf(
+				esc_html__('A partner fee for %1$s with %2$s license is not defined.', 'event_espresso'),
+				$payment_method_name,
+				$license_status
+			)
+		);
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -140,7 +140,7 @@ 
      */
     public function forPaymentMethod(string $payment_method_name): float
     {
-        if (! $this->isPartnerGateway($payment_method_name)) {
+        if ( ! $this->isPartnerGateway($payment_method_name)) {
             return 0.0;
         }
         $license_status = $this->license_data->licenseStatus();
@@ -175,8 +175,8 @@ 
      */
     private function getGatewayFee(string $payment_method_name, string $license_status): float
     {
-        if (isset($this->gateway_fees[ $license_status ][ $payment_method_name ])) {
-            return $this->gateway_fees[ $license_status ][ $payment_method_name ];
+        if (isset($this->gateway_fees[$license_status][$payment_method_name])) {
+            return $this->gateway_fees[$license_status][$payment_method_name];
         }
         throw new OutOfBoundsException(
             sprintf(

core/services/database/WpdbDataFormat.php

Indentation +50 added lines, -50 removed lines

@@ -8,65 +8,65 @@
 
 class WpdbDataFormat
 {
-    /**
-     * used for table/field names
-     */
-    const IDENTIFIER = '%i';
+	/**
+	 * used for table/field names
+	 */
+	const IDENTIFIER = '%i';
 
-    const INTEGER    = '%d';
+	const INTEGER    = '%d';
 
-    const FLOAT      = '%f';
+	const FLOAT      = '%f';
 
-    const STRING     = '%s';
+	const STRING     = '%s';
 
 
-    /**
-     * Return `%d`, `%s` or `%f` to indicate the data type for the field that should be indicated in wpdb queries.
-     *
-     * @param string $type Included if a specific type is requested.
-     * @return string
-     * @uses get_schema_type()
-     */
-    public static function getWpdbDataType(string $type = ''): string
-    {
-        switch ($type) {
-            case SchemaType::BOOLEAN:
-            case SchemaType::INTEGER:
-                return WpdbDataFormat::INTEGER; // '%d'
-            case SchemaType::DB_FIELD:
-                return WpdbDataFormat::IDENTIFIER; // '%i'
-            case SchemaType::NUMBER:
-                return WpdbDataFormat::FLOAT; // '%f'
-            case SchemaType::STRING:
-            default:
-                return WpdbDataFormat::STRING; // '%s'
-        }
-    }
+	/**
+	 * Return `%d`, `%s` or `%f` to indicate the data type for the field that should be indicated in wpdb queries.
+	 *
+	 * @param string $type Included if a specific type is requested.
+	 * @return string
+	 * @uses get_schema_type()
+	 */
+	public static function getWpdbDataType(string $type = ''): string
+	{
+		switch ($type) {
+			case SchemaType::BOOLEAN:
+			case SchemaType::INTEGER:
+				return WpdbDataFormat::INTEGER; // '%d'
+			case SchemaType::DB_FIELD:
+				return WpdbDataFormat::IDENTIFIER; // '%i'
+			case SchemaType::NUMBER:
+				return WpdbDataFormat::FLOAT; // '%f'
+			case SchemaType::STRING:
+			default:
+				return WpdbDataFormat::STRING; // '%s'
+		}
+	}
 
 
-    public static function getWpdbDataTypeForTypeArray(array $type): string
-    {
-        // first let's flip because then we can do a faster key check
-        $type = array_flip($type);
+	public static function getWpdbDataTypeForTypeArray(array $type): string
+	{
+		// first let's flip because then we can do a faster key check
+		$type = array_flip($type);
 
-        // check for things that mean '%s'
-        if (isset($type[ SchemaType::STRING ], $type[ SchemaType::OBJECT ], $type[ SchemaType::ARRAY ])) {
-            return WpdbDataFormat::STRING;
-        }
+		// check for things that mean '%s'
+		if (isset($type[ SchemaType::STRING ], $type[ SchemaType::OBJECT ], $type[ SchemaType::ARRAY ])) {
+			return WpdbDataFormat::STRING;
+		}
 
-        // if makes it past the above condition and there's float in the array
-        // then the type is %f
-        if (isset($type[ SchemaType::NUMBER ])) {
-            return WpdbDataFormat::FLOAT;
-        }
+		// if makes it past the above condition and there's float in the array
+		// then the type is %f
+		if (isset($type[ SchemaType::NUMBER ])) {
+			return WpdbDataFormat::FLOAT;
+		}
 
-        // if it makes it past the above conditions and there is an integer in the array
-        // then the type is %d
-        if (isset($type[ SchemaType::INTEGER ])) {
-            return WpdbDataFormat::INTEGER;
-        }
+		// if it makes it past the above conditions and there is an integer in the array
+		// then the type is %d
+		if (isset($type[ SchemaType::INTEGER ])) {
+			return WpdbDataFormat::INTEGER;
+		}
 
-        // anything else is a string
-        return WpdbDataFormat::STRING;
-    }
+		// anything else is a string
+		return WpdbDataFormat::STRING;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -50,19 +50,19 @@
         $type = array_flip($type);
 
         // check for things that mean '%s'
-        if (isset($type[ SchemaType::STRING ], $type[ SchemaType::OBJECT ], $type[ SchemaType::ARRAY ])) {
+        if (isset($type[SchemaType::STRING], $type[SchemaType::OBJECT], $type[SchemaType::ARRAY])) {
             return WpdbDataFormat::STRING;
         }
 
         // if makes it past the above condition and there's float in the array
         // then the type is %f
-        if (isset($type[ SchemaType::NUMBER ])) {
+        if (isset($type[SchemaType::NUMBER])) {
             return WpdbDataFormat::FLOAT;
         }
 
         // if it makes it past the above conditions and there is an integer in the array
         // then the type is %d
-        if (isset($type[ SchemaType::INTEGER ])) {
+        if (isset($type[SchemaType::INTEGER])) {
             return WpdbDataFormat::INTEGER;
         }