eventespresso / event-espresso-core

core/domain/services/graphql/resolvers/StatelessResolver.php

Indentation +101 added lines, -101 removed lines

@@ -17,105 +17,105 @@
 
 trait StatelessResolver
 {
-    protected function resolveId(EE_Base_Class $source): string
-    {
-        if (method_exists($source, 'UUID') && is_callable([$source, 'UUID'])) {
-            return $source->UUID();
-        }
-
-        return Relay::toGlobalId($source->get_model()->item_name(), $source->ID());
-    }
-
-    protected function resolveCacheId(EE_Base_Class $source): string
-    {
-        $item_name = $source->get_model()->item_name();
-        $id = $source->ID();
-        // Since cacheId does not need to be globally unique
-        // $uniqid is sufficient, still adding the model name and ID
-        // may be we need/use them in future.
-        return uniqid("{$item_name}:{$id}:", true);
-    }
-
-    protected function resolveParent(EE_Base_Class $source): ?EE_Base_Class
-    {
-        return $source->get_model()->get_one_by_ID($source->parent());
-    }
-
-    protected function resolveEvent(EE_Base_Class $source, AppContext $context): ?Deferred
-    {
-        switch (true) {
-            case $source instanceof EE_Datetime:
-                $event = $source->event();
-                break;
-            case $source instanceof EE_Venue:
-            case $source instanceof EE_Ticket:
-                $event = $source->get_related_event();
-                break;
-            default:
-                $event = null;
-                break;
-        }
-
-        if (! ($event instanceof EE_Event)) return null;
-
-        return $context->get_loader('post')->load_deferred($event->ID());
-    }
-
-    protected function resolveWpUser(EE_Base_Class $source, AppContext $context): ?Deferred
-    {
-        $user_id = $source->wp_user();
-
-        if (! $user_id) {
-            return null;
-        }
-
-        return $context->get_loader('user')->load_deferred($user_id);
-    }
-
-    protected function resolveUserId($source): ?string
-    {
-        $user_id = $source->wp_user();
-
-        if (! $user_id) {
-            return null;
-        }
-
-        return Relay::toGlobalId('user', $user_id);
-    }
-
-    protected function resolveState($source): ?EE_Base_Class
-    {
-        $state_id = null;
-
-        if ($source instanceof EE_Attendee || $source instanceof EE_Venue) {
-            $state_id = $source->state_ID();
-        }
-
-        if (! $state_id) {
-            return null;
-        }
-
-        return EEM_State::instance()->get_one_by_ID($state_id);
-    }
-
-    protected function resolveCountry(EE_Base_Class $source): ?EE_Base_Class
-    {
-        $country_iso = null;
-
-        switch (true) {
-            case $source instanceof EE_State:
-                $country_iso = $source->country_iso();
-                break;
-            case $source instanceof EE_Attendee:
-            case $source instanceof EE_Venue:
-                $country_iso = $source->country_ID();
-                break;
-        }
-
-        if (! $country_iso) {
-            return null;
-        }
-
-        return EEM_Country::instance()->get_one_by_ID($country_iso);
-    }
+	protected function resolveId(EE_Base_Class $source): string
+	{
+		if (method_exists($source, 'UUID') && is_callable([$source, 'UUID'])) {
+			return $source->UUID();
+		}
+
+		return Relay::toGlobalId($source->get_model()->item_name(), $source->ID());
+	}
+
+	protected function resolveCacheId(EE_Base_Class $source): string
+	{
+		$item_name = $source->get_model()->item_name();
+		$id = $source->ID();
+		// Since cacheId does not need to be globally unique
+		// $uniqid is sufficient, still adding the model name and ID
+		// may be we need/use them in future.
+		return uniqid("{$item_name}:{$id}:", true);
+	}
+
+	protected function resolveParent(EE_Base_Class $source): ?EE_Base_Class
+	{
+		return $source->get_model()->get_one_by_ID($source->parent());
+	}
+
+	protected function resolveEvent(EE_Base_Class $source, AppContext $context): ?Deferred
+	{
+		switch (true) {
+			case $source instanceof EE_Datetime:
+				$event = $source->event();
+				break;
+			case $source instanceof EE_Venue:
+			case $source instanceof EE_Ticket:
+				$event = $source->get_related_event();
+				break;
+			default:
+				$event = null;
+				break;
+		}
+
+		if (! ($event instanceof EE_Event)) return null;
+
+		return $context->get_loader('post')->load_deferred($event->ID());
+	}
+
+	protected function resolveWpUser(EE_Base_Class $source, AppContext $context): ?Deferred
+	{
+		$user_id = $source->wp_user();
+
+		if (! $user_id) {
+			return null;
+		}
+
+		return $context->get_loader('user')->load_deferred($user_id);
+	}
+
+	protected function resolveUserId($source): ?string
+	{
+		$user_id = $source->wp_user();
+
+		if (! $user_id) {
+			return null;
+		}
+
+		return Relay::toGlobalId('user', $user_id);
+	}
+
+	protected function resolveState($source): ?EE_Base_Class
+	{
+		$state_id = null;
+
+		if ($source instanceof EE_Attendee || $source instanceof EE_Venue) {
+			$state_id = $source->state_ID();
+		}
+
+		if (! $state_id) {
+			return null;
+		}
+
+		return EEM_State::instance()->get_one_by_ID($state_id);
+	}
+
+	protected function resolveCountry(EE_Base_Class $source): ?EE_Base_Class
+	{
+		$country_iso = null;
+
+		switch (true) {
+			case $source instanceof EE_State:
+				$country_iso = $source->country_iso();
+				break;
+			case $source instanceof EE_Attendee:
+			case $source instanceof EE_Venue:
+				$country_iso = $source->country_ID();
+				break;
+		}
+
+		if (! $country_iso) {
+			return null;
+		}
+
+		return EEM_Country::instance()->get_one_by_ID($country_iso);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -56,7 +56,7 @@ 
                 break;
         }
 
-        if (! ($event instanceof EE_Event)) return null;
+        if ( ! ($event instanceof EE_Event)) return null;
 
         return $context->get_loader('post')->load_deferred($event->ID());
     }
@@ -65,7 +65,7 @@ 
     {
         $user_id = $source->wp_user();
 
-        if (! $user_id) {
+        if ( ! $user_id) {
             return null;
         }
 
@@ -76,7 +76,7 @@ 
     {
         $user_id = $source->wp_user();
 
-        if (! $user_id) {
+        if ( ! $user_id) {
             return null;
         }
 
@@ -91,7 +91,7 @@ 
             $state_id = $source->state_ID();
         }
 
-        if (! $state_id) {
+        if ( ! $state_id) {
             return null;
         }
 
@@ -112,7 +112,7 @@ 
                 break;
         }
 
-        if (! $country_iso) {
+        if ( ! $country_iso) {
             return null;
         }
 

Braces +3 added lines, -1 removed lines

@@ -56,7 +56,9 @@
                 break;
         }
 
-        if (! ($event instanceof EE_Event)) return null;
+        if (! ($event instanceof EE_Event)) {
+        	return null;
+        }
 
         return $context->get_loader('post')->load_deferred($event->ID());
     }

core/domain/services/graphql/interfaces/GraphQLNode.php

Indentation +21 added lines, -21 removed lines

@@ -8,26 +8,26 @@
 
 class GraphQLNode extends GraphQLInterface
 {
-    protected function getShortName(): string
-    {
-        return 'Node';
-    }
+	protected function getShortName(): string
+	{
+		return 'Node';
+	}
 
-    protected function getArrayOfFields(): array
-    {
-        return [
-            new GraphQLOutputField(
-                'id',
-                Type::nonNull(Type::string()),
-                null,
-                esc_html__('The globally unique ID for the object.', 'event_espresso')
-            ),
-            new GraphQLOutputField(
-                'dbId',
-                Type::nonNull(Type::string()),
-                'ID',
-                esc_html__('Database table ID', 'event_espresso')
-            ),
-        ];
-    }
+	protected function getArrayOfFields(): array
+	{
+		return [
+			new GraphQLOutputField(
+				'id',
+				Type::nonNull(Type::string()),
+				null,
+				esc_html__('The globally unique ID for the object.', 'event_espresso')
+			),
+			new GraphQLOutputField(
+				'dbId',
+				Type::nonNull(Type::string()),
+				'ID',
+				esc_html__('Database table ID', 'event_espresso')
+			),
+		];
+	}
 }

core/domain/services/converters/RestApiSpoofer.php

Indentation +110 added lines, -110 removed lines

@@ -29,126 +29,126 @@
  */
 class RestApiSpoofer
 {
-    protected EED_Core_Rest_Api $rest_module;
+	protected EED_Core_Rest_Api $rest_module;
 
-    protected Read              $rest_controller;
+	protected Read              $rest_controller;
 
-    protected WP_REST_Server    $wp_rest_server;
+	protected WP_REST_Server    $wp_rest_server;
 
 
-    /**
-     * RestApiSpoofer constructor.
-     *
-     * @param WP_REST_Server    $wp_rest_server
-     * @param EED_Core_Rest_Api $rest_module
-     * @param Read              $rest_api
-     * @param string            $api_version
-     */
-    public function __construct(
-        WP_REST_Server $wp_rest_server,
-        EED_Core_Rest_Api $rest_module,
-        Read $rest_api,
-        string $api_version = '4.8.36'
-    ) {
-        $this->wp_rest_server  = $wp_rest_server;
-        $this->rest_module     = $rest_module;
-        $this->rest_controller = $rest_api;
-        $this->rest_controller->setRequestedVersion($api_version);
-        $this->setUpRestServer();
-    }
+	/**
+	 * RestApiSpoofer constructor.
+	 *
+	 * @param WP_REST_Server    $wp_rest_server
+	 * @param EED_Core_Rest_Api $rest_module
+	 * @param Read              $rest_api
+	 * @param string            $api_version
+	 */
+	public function __construct(
+		WP_REST_Server $wp_rest_server,
+		EED_Core_Rest_Api $rest_module,
+		Read $rest_api,
+		string $api_version = '4.8.36'
+	) {
+		$this->wp_rest_server  = $wp_rest_server;
+		$this->rest_module     = $rest_module;
+		$this->rest_controller = $rest_api;
+		$this->rest_controller->setRequestedVersion($api_version);
+		$this->setUpRestServer();
+	}
 
 
-    private function setUpRestServer()
-    {
-        /* @var WP_REST_Server $wp_rest_server */
-        global $wp_rest_server;
-        $wp_rest_server = $this->wp_rest_server;
-        EED_Core_Rest_Api::set_hooks_both();
-        do_action('rest_api_init', $this->wp_rest_server);
-    }
+	private function setUpRestServer()
+	{
+		/* @var WP_REST_Server $wp_rest_server */
+		global $wp_rest_server;
+		$wp_rest_server = $this->wp_rest_server;
+		EED_Core_Rest_Api::set_hooks_both();
+		do_action('rest_api_init', $this->wp_rest_server);
+	}
 
 
-    /**
-     * @param EEM_Base $model
-     * @param array    $query_params
-     * @param string   $include
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ModelConfigurationException
-     * @throws ReflectionException
-     * @throws RestException
-     * @throws RestPasswordIncorrectException
-     * @throws RestPasswordRequiredException
-     * @throws UnexpectedEntityException
-     * @throws DomainException
-     * @since 5.0.0.p
-     */
-    public function getOneApiResult(EEM_Base $model, array $query_params, string $include = '')
-    {
-        if (! array_key_exists('limit', $query_params)) {
-            $query_params['limit'] = 1;
-        }
-        $result = $this->getApiResults($model, $query_params, $include);
-        return $result[0] ?? [];
-    }
+	/**
+	 * @param EEM_Base $model
+	 * @param array    $query_params
+	 * @param string   $include
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ModelConfigurationException
+	 * @throws ReflectionException
+	 * @throws RestException
+	 * @throws RestPasswordIncorrectException
+	 * @throws RestPasswordRequiredException
+	 * @throws UnexpectedEntityException
+	 * @throws DomainException
+	 * @since 5.0.0.p
+	 */
+	public function getOneApiResult(EEM_Base $model, array $query_params, string $include = '')
+	{
+		if (! array_key_exists('limit', $query_params)) {
+			$query_params['limit'] = 1;
+		}
+		$result = $this->getApiResults($model, $query_params, $include);
+		return $result[0] ?? [];
+	}
 
 
-    /**
-     * @param EEM_Base $model
-     * @param array    $query_params
-     * @param string   $include
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ModelConfigurationException
-     * @throws ReflectionException
-     * @throws RestException
-     * @throws RestPasswordIncorrectException
-     * @throws RestPasswordRequiredException
-     * @throws UnexpectedEntityException
-     * @throws DomainException
-     * @since 5.0.0.p
-     */
-    public function getApiResults(EEM_Base $model, array $query_params, string $include = ''): array
-    {
-        if (! array_key_exists('caps', $query_params)) {
-            $query_params['caps'] = EEM_Base::caps_read_admin;
-        }
-        if (! array_key_exists('default_where_conditions', $query_params)) {
-            $query_params['default_where_conditions'] = 'none';
-        }
-        /** @type array $results */
-        $results      = $model->get_all_wpdb_results($query_params);
-        $rest_request = new WP_REST_Request();
-        $rest_request->set_param('include', $include);
-        $rest_request->set_param('caps', 'edit');
-        $nice_results = [];
-        foreach ($results as $result) {
-            $nice_results[] = $this->rest_controller->createEntityFromWpdbResult(
-                $model,
-                $result,
-                $rest_request
-            );
-        }
-        return $nice_results;
-    }
+	/**
+	 * @param EEM_Base $model
+	 * @param array    $query_params
+	 * @param string   $include
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ModelConfigurationException
+	 * @throws ReflectionException
+	 * @throws RestException
+	 * @throws RestPasswordIncorrectException
+	 * @throws RestPasswordRequiredException
+	 * @throws UnexpectedEntityException
+	 * @throws DomainException
+	 * @since 5.0.0.p
+	 */
+	public function getApiResults(EEM_Base $model, array $query_params, string $include = ''): array
+	{
+		if (! array_key_exists('caps', $query_params)) {
+			$query_params['caps'] = EEM_Base::caps_read_admin;
+		}
+		if (! array_key_exists('default_where_conditions', $query_params)) {
+			$query_params['default_where_conditions'] = 'none';
+		}
+		/** @type array $results */
+		$results      = $model->get_all_wpdb_results($query_params);
+		$rest_request = new WP_REST_Request();
+		$rest_request->set_param('include', $include);
+		$rest_request->set_param('caps', 'edit');
+		$nice_results = [];
+		foreach ($results as $result) {
+			$nice_results[] = $this->rest_controller->createEntityFromWpdbResult(
+				$model,
+				$result,
+				$rest_request
+			);
+		}
+		return $nice_results;
+	}
 
 
-    /**
-     * @param string $endpoint
-     * @return array
-     * @since 5.0.0.p
-     */
-    public function getModelSchema(string $endpoint)
-    {
-        $response = $this->wp_rest_server->dispatch(
-            new WP_REST_Request('OPTIONS', "/ee/v4.8.36/$endpoint")
-        );
-        return $response->get_data();
-    }
+	/**
+	 * @param string $endpoint
+	 * @return array
+	 * @since 5.0.0.p
+	 */
+	public function getModelSchema(string $endpoint)
+	{
+		$response = $this->wp_rest_server->dispatch(
+			new WP_REST_Request('OPTIONS', "/ee/v4.8.36/$endpoint")
+		);
+		return $response->get_data();
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -88,7 +88,7 @@ 
      */
     public function getOneApiResult(EEM_Base $model, array $query_params, string $include = '')
     {
-        if (! array_key_exists('limit', $query_params)) {
+        if ( ! array_key_exists('limit', $query_params)) {
             $query_params['limit'] = 1;
         }
         $result = $this->getApiResults($model, $query_params, $include);
@@ -116,10 +116,10 @@ 
      */
     public function getApiResults(EEM_Base $model, array $query_params, string $include = ''): array
     {
-        if (! array_key_exists('caps', $query_params)) {
+        if ( ! array_key_exists('caps', $query_params)) {
             $query_params['caps'] = EEM_Base::caps_read_admin;
         }
-        if (! array_key_exists('default_where_conditions', $query_params)) {
+        if ( ! array_key_exists('default_where_conditions', $query_params)) {
             $query_params['default_where_conditions'] = 'none';
         }
         /** @type array $results */

core/domain/entities/routing/handlers/shared/RegularRequests.php

Indentation +139 added lines, -139 removed lines

@@ -31,151 +31,151 @@
  */
 class RegularRequests extends PrimaryRoute
 {
-    /**
-     * called just before matchesCurrentRequest()
-     * and allows Route to perform any setup required such as calling setSpecification()
-     *
-     * @since 5.0.0.p
-     */
-    public function initialize()
-    {
-        $basic_nodes = [
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\Api',
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\Capabilities',
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\Locale',
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\SiteUrls',
-        ];
-        foreach ($basic_nodes as $basic_node) {
-            $this->dependency_map->registerDependencies(
-                $basic_node,
-                ['EventEspresso\core\services\json\JsonDataNodeValidator' => EE_Dependency_Map::load_from_cache]
-            );
-        }
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\SitePermissions',
-            [
-                'EventEspresso\core\domain\services\capabilities\FeatureFlags' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\json\JsonDataNodeValidator'       => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\GeneralSettings',
-            [
-                'EventEspresso\core\services\json\JsonDataNodeValidator'                => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\converters\date_time_formats\PhpToUnicode' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\data_nodes\EventEspressoData',
-            [
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\Api'    => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\Config' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\assets\JedLocaleData'                  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\json\JsonDataNodeValidator'            => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\Config',
-            [
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\CurrentUser'        => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\EspressoCoreDomain' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\GeneralSettings'    => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\Locale'             => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\SiteCurrency'       => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\SitePermissions'    => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\SiteUrls'           => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\json\JsonDataNodeValidator'                        => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\CurrentUser',
-            [
-                'EventEspresso\core\domain\entities\routing\data_nodes\core\Capabilities' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\json\JsonDataNodeValidator'                  => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\EspressoCoreDomain',
-            [
-                'EventEspresso\core\domain\Domain'                       => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\json\JsonDataNodeValidator' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\entities\routing\data_nodes\core\SiteCurrency',
-            [
-                'EE_Currency_Config'                                     => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\json\JsonDataNodeValidator' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->setDataNode(
-            $this->loader->getShared('EventEspresso\core\domain\entities\routing\data_nodes\EventEspressoData')
-        );
-    }
+	/**
+	 * called just before matchesCurrentRequest()
+	 * and allows Route to perform any setup required such as calling setSpecification()
+	 *
+	 * @since 5.0.0.p
+	 */
+	public function initialize()
+	{
+		$basic_nodes = [
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\Api',
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\Capabilities',
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\Locale',
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\SiteUrls',
+		];
+		foreach ($basic_nodes as $basic_node) {
+			$this->dependency_map->registerDependencies(
+				$basic_node,
+				['EventEspresso\core\services\json\JsonDataNodeValidator' => EE_Dependency_Map::load_from_cache]
+			);
+		}
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\SitePermissions',
+			[
+				'EventEspresso\core\domain\services\capabilities\FeatureFlags' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\json\JsonDataNodeValidator'       => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\GeneralSettings',
+			[
+				'EventEspresso\core\services\json\JsonDataNodeValidator'                => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\converters\date_time_formats\PhpToUnicode' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\data_nodes\EventEspressoData',
+			[
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\Api'    => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\Config' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\assets\JedLocaleData'                  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\json\JsonDataNodeValidator'            => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\Config',
+			[
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\CurrentUser'        => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\EspressoCoreDomain' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\GeneralSettings'    => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\Locale'             => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\SiteCurrency'       => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\SitePermissions'    => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\SiteUrls'           => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\json\JsonDataNodeValidator'                        => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\CurrentUser',
+			[
+				'EventEspresso\core\domain\entities\routing\data_nodes\core\Capabilities' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\json\JsonDataNodeValidator'                  => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\EspressoCoreDomain',
+			[
+				'EventEspresso\core\domain\Domain'                       => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\json\JsonDataNodeValidator' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\entities\routing\data_nodes\core\SiteCurrency',
+			[
+				'EE_Currency_Config'                                     => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\json\JsonDataNodeValidator' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->setDataNode(
+			$this->loader->getShared('EventEspresso\core\domain\entities\routing\data_nodes\EventEspressoData')
+		);
+	}
 
 
-    /**
-     * returns true if the current request matches this route
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        return ! $this->request->isActivation() || $this->request->isUnitTesting();
-    }
+	/**
+	 * returns true if the current request matches this route
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		return ! $this->request->isActivation() || $this->request->isUnitTesting();
+	}
 
 
-    /**
-     * @since 5.0.0.p
-     */
-    protected function registerDependencies()
-    {
-        $public = ['EE_Maintenance_Mode' => EE_Dependency_Map::load_from_cache] + Route::getDefaultDependencies();
+	/**
+	 * @since 5.0.0.p
+	 */
+	protected function registerDependencies()
+	{
+		$public = ['EE_Maintenance_Mode' => EE_Dependency_Map::load_from_cache] + Route::getDefaultDependencies();
 
-        $default_with_barista  = [BaristaFactory::class => EE_Dependency_Map::load_from_cache] +
-                                 Route::getDefaultDependencies();
-        $default_with_manifest = [AssetManifestFactory::class => EE_Dependency_Map::load_from_cache] +
-                                 Route::getDefaultDependencies();
+		$default_with_barista  = [BaristaFactory::class => EE_Dependency_Map::load_from_cache] +
+								 Route::getDefaultDependencies();
+		$default_with_manifest = [AssetManifestFactory::class => EE_Dependency_Map::load_from_cache] +
+								 Route::getDefaultDependencies();
 
-        $default_routes = [
-            // default dependencies
-            ShortcodeRequests::class    => Route::getDefaultDependencies(),
-            RestApiRequests::class      => Route::getDefaultDependencies(),
-            SessionRequests::class      => Route::getDefaultDependencies(),
-            WordPressHeartbeat::class   => Route::getDefaultDependencies(),
-            AssetRequests::class        => $default_with_barista,
-            GQLRequests::class          => $default_with_manifest,
-            // admin dependencies
-            AdminRoute::class           => AdminRoute::getDefaultDependencies(),
-            EspressoBatchJob::class     => AdminRoute::getDefaultDependencies(),
-            EspressoEventsAdmin::class  => AdminRoute::getDefaultDependencies(),
-            EspressoEventEditor::class  => AdminRoute::getDefaultDependencies(),
-            EspressoLegacyAdmin::class  => AdminRoute::getDefaultDependencies(),
-            GutenbergEditor::class      => AdminRoute::getDefaultDependencies(),
-            NonEspressoAdminAjax::class => AdminRoute::getDefaultDependencies(),
-            WordPressPluginsPage::class => AdminRoute::getDefaultDependencies(),
-            WordPressPostsPage::class   => AdminRoute::getDefaultDependencies(),
-            WordPressProfilePage::class => AdminRoute::getDefaultDependencies(),
-            // public dependencies
-            PersonalDataRequests::class => $public,
-            FrontendRequests::class     => $public,
-        ];
-        foreach ($default_routes as $route => $dependencies) {
-            $this->dependency_map->registerDependencies($route, $dependencies);
-        }
-    }
+		$default_routes = [
+			// default dependencies
+			ShortcodeRequests::class    => Route::getDefaultDependencies(),
+			RestApiRequests::class      => Route::getDefaultDependencies(),
+			SessionRequests::class      => Route::getDefaultDependencies(),
+			WordPressHeartbeat::class   => Route::getDefaultDependencies(),
+			AssetRequests::class        => $default_with_barista,
+			GQLRequests::class          => $default_with_manifest,
+			// admin dependencies
+			AdminRoute::class           => AdminRoute::getDefaultDependencies(),
+			EspressoBatchJob::class     => AdminRoute::getDefaultDependencies(),
+			EspressoEventsAdmin::class  => AdminRoute::getDefaultDependencies(),
+			EspressoEventEditor::class  => AdminRoute::getDefaultDependencies(),
+			EspressoLegacyAdmin::class  => AdminRoute::getDefaultDependencies(),
+			GutenbergEditor::class      => AdminRoute::getDefaultDependencies(),
+			NonEspressoAdminAjax::class => AdminRoute::getDefaultDependencies(),
+			WordPressPluginsPage::class => AdminRoute::getDefaultDependencies(),
+			WordPressPostsPage::class   => AdminRoute::getDefaultDependencies(),
+			WordPressProfilePage::class => AdminRoute::getDefaultDependencies(),
+			// public dependencies
+			PersonalDataRequests::class => $public,
+			FrontendRequests::class     => $public,
+		];
+		foreach ($default_routes as $route => $dependencies) {
+			$this->dependency_map->registerDependencies($route, $dependencies);
+		}
+	}
 
 
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    protected function requestHandler(): bool
-    {
-        $this->setRouteRequestType(PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR);
-        return true;
-    }
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	protected function requestHandler(): bool
+	{
+		$this->setRouteRequestType(PrimaryRoute::ROUTE_REQUEST_TYPE_REGULAR);
+		return true;
+	}
 }

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

Indentation +42 added lines, -42 removed lines

@@ -18,46 +18,46 @@
 class EspressoBatchJob extends AdminRoute
 {
 
-    /**
-     * returns true if the current request matches this route
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        global $pagenow;
-        $page = $this->request->getRequestParam('page');
-        return ($pagenow === 'admin.php' || $pagenow === 'admin-ajax.php')
-               && $page === 'espresso_batch'
-               && parent::matchesCurrentRequest();
-    }
-
-
-    /**
-     * @since 5.0.0.p
-     */
-    protected function registerDependencies()
-    {
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\admin\registrations\list_table\QueryBuilder',
-            [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EEM_Registration'                            => EE_Dependency_Map::load_from_cache,
-                null,
-            ]
-        );
-    }
-
-
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    protected function requestHandler(): bool
-    {
-        return true;
-    }
+	/**
+	 * returns true if the current request matches this route
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		global $pagenow;
+		$page = $this->request->getRequestParam('page');
+		return ($pagenow === 'admin.php' || $pagenow === 'admin-ajax.php')
+			   && $page === 'espresso_batch'
+			   && parent::matchesCurrentRequest();
+	}
+
+
+	/**
+	 * @since 5.0.0.p
+	 */
+	protected function registerDependencies()
+	{
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\admin\registrations\list_table\QueryBuilder',
+			[
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EEM_Registration'                            => EE_Dependency_Map::load_from_cache,
+				null,
+			]
+		);
+	}
+
+
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	protected function requestHandler(): bool
+	{
+		return true;
+	}
 }

core/business/EE_Registration_Processor.class.php

Indentation +673 added lines, -673 removed lines

@@ -22,677 +22,677 @@
  */
 class EE_Registration_Processor extends EE_Processor_Base
 {
-    private static ?EE_Registration_Processor $_instance = null;
-
-    protected RequestInterface $request;
-
-    /**
-     * initial reg status at the beginning of this request.
-     * indexed by registration ID
-     *
-     * @var array
-     */
-    protected array $_old_reg_status = [];
-
-    /**
-     * reg status at the end of the request after all processing.
-     * indexed by registration ID
-     *
-     * @var array
-     */
-    protected array $_new_reg_status = [];
-
-    /**
-     * amounts paid at the end of the request after all processing.
-     * indexed by registration ID
-     *
-     * @var array
-     */
-    protected static array $_amount_paid = [];
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param RequestInterface|null $request
-     * @return EE_Registration_Processor instance
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function instance(RequestInterface $request = null): EE_Registration_Processor
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Registration_Processor) {
-            if (! $request instanceof RequestInterface) {
-                $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
-            }
-            self::$_instance = new self($request);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * EE_Registration_Processor constructor.
-     *
-     * @param RequestInterface $request
-     */
-    public function __construct(RequestInterface $request)
-    {
-        $this->request = $request;
-    }
-
-
-    /**
-     * @param int $REG_ID
-     * @return string
-     */
-    public function old_reg_status(int $REG_ID): ?string
-    {
-        return $this->_old_reg_status[ $REG_ID ] ?? null;
-    }
-
-
-    /**
-     * @param int    $REG_ID
-     * @param string $old_reg_status
-     */
-    public function set_old_reg_status(int $REG_ID, string $old_reg_status)
-    {
-        // only set the first time
-        if (! isset($this->_old_reg_status[ $REG_ID ])) {
-            $this->_old_reg_status[ $REG_ID ] = $old_reg_status;
-        }
-    }
-
-
-    /**
-     * @param int $REG_ID
-     * @return string
-     */
-    public function new_reg_status(int $REG_ID): ?string
-    {
-        return $this->_new_reg_status[ $REG_ID ] ?? null;
-    }
-
-
-    /**
-     * @param int    $REG_ID
-     * @param string $new_reg_status
-     */
-    public function set_new_reg_status(int $REG_ID, string $new_reg_status)
-    {
-        $this->_new_reg_status[ $REG_ID ] = $new_reg_status;
-    }
-
-
-    /**
-     * @param int $REG_ID
-     * @return bool
-     */
-    public function reg_status_updated(int $REG_ID): bool
-    {
-        return $this->new_reg_status($REG_ID) !== $this->old_reg_status($REG_ID);
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function update_registration_status_and_trigger_notifications(EE_Registration $registration)
-    {
-        $this->toggle_incomplete_registration_status_to_default(
-            $registration,
-            false,
-            new Context(
-                __METHOD__,
-                esc_html__(
-                    'Executed when the registration status is updated during the registration process just prior to triggering notifications.',
-                    'event_espresso'
-                )
-            )
-        );
-        $this->toggle_registration_status_for_default_approved_events($registration, false);
-        $this->toggle_registration_status_if_no_monies_owing($registration, false);
-        $registration->save();
-        // trigger notifications
-        $this->trigger_registration_update_notifications($registration);
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param string          $new_reg_status
-     * @param bool            $save            TRUE will save the registration if the status is updated,
-     *                                         FALSE will leave that up to client code
-     * @return bool
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function manually_update_registration_status(
-        EE_Registration $registration,
-        string $new_reg_status = '',
-        bool $save = true
-    ): bool {
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $registration->status_ID());
-        // set incoming REG_Status
-        $this->set_new_reg_status($registration->ID(), $new_reg_status);
-        // toggle reg status but only if it has changed and the user can do so
-        if (
-            $this->reg_status_updated($registration->ID())
-            && (
-                (! $this->request->isAdmin() || $this->request->isFrontAjax())
-                || EE_Registry::instance()->CAP->current_user_can(
-                    'ee_edit_registration',
-                    'toggle_registration_status',
-                    $registration->ID()
-                )
-            )
-        ) {
-            // change status to new value
-            $updated = $registration->set_status(
-                $this->new_reg_status($registration->ID()),
-                false,
-                new Context(
-                    __METHOD__,
-                    esc_html__(
-                        'Executed when the registration status is manually updated during the reg process.',
-                        'event_espresso'
-                    )
-                )
-            );
-            if ($updated && $save) {
-                $registration->save();
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * changes any incomplete registrations to either the event or global default registration status
-     *
-     * @param EE_Registration       $registration
-     * @param bool                  $save           TRUE will save the registration if the status is updated,
-     *                                              FALSE will leave that up to client code
-     * @param ContextInterface|null $context
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function toggle_incomplete_registration_status_to_default(
-        EE_Registration $registration,
-        bool $save = true,
-        ?ContextInterface $context = null
-    ) {
-        $existing_reg_status = $registration->status_ID();
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $existing_reg_status);
-        // is the registration currently incomplete ?
-        if ($registration->status_ID() === RegStatus::INCOMPLETE) {
-            // grab default reg status for the event, if set
-            $event_default_registration_status = $registration->defaultRegistrationStatus();
-            // if no default reg status is set for the event, then use the global value
-            $STS_ID = ! empty($event_default_registration_status)
-                ? $event_default_registration_status
-                : EE_Registry::instance()->CFG->registration->default_STS_ID;
-            // if the event default reg status is approved, then downgrade temporarily to payment pending to ensure that payments are triggered
-            $STS_ID = $STS_ID === RegStatus::APPROVED
-                ? RegStatus::PENDING_PAYMENT
-                : $STS_ID;
-            // set incoming REG_Status
-            $this->set_new_reg_status($registration->ID(), $STS_ID);
-            $context = $context instanceof ContextInterface
-                ? $context
-                : new Context(
-                    __METHOD__,
-                    esc_html__(
-                        'Executed when the registration status is updated to the default reg status during the registration process.',
-                        'event_espresso'
-                    )
-                );
-            $registration->set_status($STS_ID, false, $context);
-            if ($save) {
-                $registration->save();
-            }
-            // don't trigger notifications during IPNs because they will get triggered by
-            // EventEspresso\core\services\payments\PostPaymentProcessor
-            if (! EE_Processor_Base::$IPN) {
-                // otherwise, send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-            }
-            // DEBUG LOG
-            // $this->log(
-            //     __CLASS__,
-            //     __FUNCTION__,
-            //     __LINE__,
-            //     $registration->transaction(),
-            //     array(
-            //         'IPN' => EE_Processor_Base::$IPN,
-            //         'deliver_notifications' => has_filter(
-            //             'FHEE__EED_Messages___maybe_registration__deliver_notifications'
-            //         ),
-            //     )
-            // );
-        }
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param bool            $save         TRUE will save the registration if the status is updated,
-     *                                      FALSE will leave that up to client code
-     * @return bool
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function toggle_registration_status_for_default_approved_events(
-        EE_Registration $registration,
-        bool $save = true
-    ): bool {
-        $reg_status = $registration->status_ID();
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $reg_status);
-        // if not already, toggle reg status to approved IF the event default reg status is approved
-        // ( as long as the registration wasn't cancelled or declined at some point )
-        if (
-            $reg_status !== RegStatus::CANCELLED
-            && $reg_status !== RegStatus::DECLINED
-            && $reg_status !== RegStatus::APPROVED
-            && $registration->defaultRegistrationStatus() === RegStatus::APPROVED
-        ) {
-            // set incoming REG_Status
-            $this->set_new_reg_status($registration->ID(), RegStatus::APPROVED);
-            // toggle status to approved
-            $registration->set_status(
-                RegStatus::APPROVED,
-                false,
-                new Context(
-                    __METHOD__,
-                    esc_html__(
-                        'Executed when the registration status is updated for events with a default reg status of RegStatus::APPROVED.',
-                        'event_espresso'
-                    )
-                )
-            );
-            if ($save) {
-                $registration->save();
-            }
-            // don't trigger notifications during IPNs because they will get triggered by
-            // EventEspresso\core\services\payments\PostPaymentProcessor
-            if (! EE_Processor_Base::$IPN) {
-                // otherwise, send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-            }
-            // DEBUG LOG
-            // $this->log(
-            //     __CLASS__,
-            //     __FUNCTION__,
-            //     __LINE__,
-            //     $registration->transaction(),
-            //     array(
-            //         'IPN' => EE_Processor_Base::$IPN,
-            //         'deliver_notifications' => has_filter(
-            //             'FHEE__EED_Messages___maybe_registration__deliver_notifications'
-            //         ),
-            //     )
-            // );
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     *    toggle_registration_statuses_if_no_monies_owing
-     *
-     * @param EE_Registration $registration
-     * @param bool            $save                 TRUE will save the registration if the status is updated,
-     *                                              FALSE will leave that up to client code
-     * @param array           $additional_details
-     * @return bool
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function toggle_registration_status_if_no_monies_owing(
-        EE_Registration $registration,
-        bool $save = true,
-        array $additional_details = []
-    ): bool {
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $registration->status_ID());
-        // was a payment just made ?
-        $payment    = isset($additional_details['payment_updates'], $additional_details['last_payment'])
-        && $additional_details['payment_updates']
-        && $additional_details['last_payment'] instanceof EE_Payment
-            ? $additional_details['last_payment']
-            : null;
-        $total_paid = array_sum(self::$_amount_paid);
-        // toggle reg status to approved IF
-        if (
-            // REG status is pending payment
-            $registration->status_ID() === RegStatus::PENDING_PAYMENT
-            // AND no monies are owing
-            && (
-                (
-                    $registration->transaction()->is_completed()
-                    || $registration->transaction()->is_overpaid()
-                    || $registration->transaction()->is_free()
-                    || apply_filters(
-                        'FHEE__EE_Registration_Processor__toggle_registration_status_if_no_monies_owing',
-                        false,
-                        $registration
-                    )
-                )
-                || (
-                    $payment instanceof EE_Payment && $payment->is_approved()
-                    // this specific registration has not yet been paid for
-                    && ! isset(self::$_amount_paid[ $registration->ID() ])
-                    // payment amount, less what we have already attributed to other registrations,
-                    // is greater than this registration's final price
-                    && $payment->amount() - $total_paid >= $registration->final_price()
-                )
-            )
-        ) {
-            // mark as paid
-            self::$_amount_paid[ $registration->ID() ] = $registration->final_price();
-            // track new REG_Status
-            $this->set_new_reg_status($registration->ID(), RegStatus::APPROVED);
-            // toggle status to approved
-            $registration->set_status(
-                RegStatus::APPROVED,
-                false,
-                new Context(
-                    __METHOD__,
-                    esc_html__(
-                        'Executed when the registration status is updated to RegStatus::APPROVED when no monies are owing.',
-                        'event_espresso'
-                    )
-                )
-            );
-            if ($save) {
-                $registration->save();
-            }
-            // don't trigger notifications during IPNs because they will get triggered by
-            // EventEspresso\core\services\payments\PostPaymentProcessor
-            if (! EE_Processor_Base::$IPN) {
-                // otherwise, send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-            }
-            // DEBUG LOG
-            // $this->log(
-            //     __CLASS__,
-            //     __FUNCTION__,
-            //     __LINE__,
-            //     $registration->transaction(),
-            //     array(
-            //         'IPN' => EE_Processor_Base::$IPN,
-            //         'deliver_notifications' => has_filter(
-            //             'FHEE__EED_Messages___maybe_registration__deliver_notifications'
-            //         ),
-            //     )
-            // );
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * @param EE_Registration|null $registration
-     * @param array                $additional_details
-     * @return void
-     */
-    public function trigger_registration_update_notifications(
-        ?EE_Registration $registration,
-        array $additional_details = []
-    ) {
-        try {
-            if (! $registration instanceof EE_Registration) {
-                throw new EE_Error(
-                    esc_html__('An invalid registration was received.', 'event_espresso')
-                );
-            }
-            // EE_Registry::instance()->load_helper('Debug_Tools');
-            // EEH_Debug_Tools::log(
-            //     __CLASS__,
-            //     __FUNCTION__,
-            //     __LINE__,
-            //     array($registration->transaction(), $additional_details),
-            //     false,
-            //     'EE_Transaction: ' . $registration->transaction()->ID()
-            // );
-            if (
-                ! $this->request->getRequestParam('non_primary_reg_notification', 0, 'int')
-                && ! $registration->is_primary_registrant()
-            ) {
-                return;
-            }
-            do_action(
-                'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
-                $registration,
-                $additional_details
-            );
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), $e->getFile(), 'unknown_function_from_exception', $e->getLine());
-        }
-    }
-
-
-    /**
-     * sets reg status based either on passed param or on transaction status and event pre-approval setting
-     *
-     * @param EE_Registration $registration
-     * @param array           $additional_details
-     * @return bool
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function update_registration_after_checkout_or_payment(
-        EE_Registration $registration,
-        array $additional_details = []
-    ): bool {
-        // set initial REG_Status
-        $this->set_old_reg_status($registration->ID(), $registration->status_ID());
-        // if the registration status gets updated, then save the registration
-        if (
-            $this->toggle_registration_status_for_default_approved_events($registration, false)
-            || $this->toggle_registration_status_if_no_monies_owing(
-                $registration,
-                false,
-                $additional_details
-            )
-        ) {
-            $registration->save();
-        }
-        // set new  REG_Status
-        $this->set_new_reg_status($registration->ID(), $registration->status_ID());
-        return $this->reg_status_updated($registration->ID())
-            && $this->new_reg_status($registration->ID()) === RegStatus::APPROVED;
-    }
-
-
-    /**
-     * Updates the registration' final prices based on the current line item tree (taking into account
-     * discounts, taxes, and other line items unrelated to tickets.)
-     *
-     * @param EE_Transaction $transaction
-     * @param boolean        $save_regs whether to immediately save registrations in this function or not
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    public function update_registration_final_prices(EE_Transaction $transaction, bool $save_regs = true)
-    {
-        $reg_final_price_per_ticket_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item(
-            $transaction->total_line_item()
-        );
-        foreach ($transaction->registrations() as $registration) {
-            /** @var EE_Line_Item $line_item */
-            $line_item = EEM_Line_Item::instance()->get_line_item_for_registration($registration);
-            if (isset($reg_final_price_per_ticket_line_item[ $line_item->ID() ])) {
-                $registration->set_final_price($reg_final_price_per_ticket_line_item[ $line_item->ID() ]);
-                if ($save_regs) {
-                    $registration->save();
-                }
-            }
-        }
-        // and make sure there's no rounding problem
-        $this->fix_reg_final_price_rounding_issue($transaction);
-    }
-
-
-    /**
-     * Makes sure there is no rounding errors for the REG_final_prices.
-     * Eg, if we have 3 registrations for $1, and there is a $0.01 discount between the three of them,
-     * they will each be for $0.99333333, which gets rounded to $1 again.
-     * So the transaction total will be $2.99, but each registration will be for $1,
-     * so if each registrant paid individually they will have overpaid by $0.01.
-     * So in order to overcome this, we check for any difference, and if there is a difference
-     * we just grab one registrant at random and make them responsible for it.
-     * This should be used after setting REG_final_prices (it's done automatically as part of
-     * EE_Registration_Processor::update_registration_final_prices())
-     *
-     * @param EE_Transaction $transaction
-     * @return bool success verifying that there is NO difference after this method is done
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function fix_reg_final_price_rounding_issue(EE_Transaction $transaction): bool
-    {
-        $reg_final_price_sum = EEM_Registration::instance()->sum(
-            [
-                [
-                    'TXN_ID' => $transaction->ID(),
-                ],
-            ],
-            'REG_final_price'
-        );
-        $diff                = $transaction->total() - $reg_final_price_sum;
-        // ok then, just grab one of the registrations
-        if ($diff !== 0.0) {
-            $a_reg = EEM_Registration::instance()->get_one(
-                [
-                    [
-                        'TXN_ID' => $transaction->ID(),
-                    ],
-                ]
-            );
-            return $a_reg instanceof EE_Registration
-                && $a_reg->save(['REG_final_price' => $a_reg->final_price() + $diff]);
-        }
-        return true;
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param array           $closed_reg_statuses
-     * @param bool            $update_reg
-     * @return bool
-     * @throws EE_Error
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    public function update_registration_after_being_canceled_or_declined(
-        EE_Registration $registration,
-        array $closed_reg_statuses = [],
-        bool $update_reg = true
-    ): bool {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses)
-            ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
-            return false;
-        }
-        // release a reserved ticket by decrementing ticket and datetime reserved values
-        $registration->release_reserved_ticket(true, 'RegProcessor:' . __LINE__);
-        $registration->set_final_price(0);
-        if ($update_reg) {
-            $registration->save();
-        }
-        return true;
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param array           $closed_reg_statuses
-     * @param bool            $update_reg
-     * @return bool
-     * @throws EE_Error
-     * @throws RuntimeException
-     * @throws ReflectionException
-     */
-    public function update_canceled_or_declined_registration_after_being_reinstated(
-        EE_Registration $registration,
-        array $closed_reg_statuses = [],
-        bool $update_reg = true
-    ): bool {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
-            return false;
-        }
-        $ticket = $registration->ticket();
-        if (! $ticket instanceof EE_Ticket) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The Ticket for Registration %1$d was not found or is invalid.',
-                        'event_espresso'
-                    ),
-                    $registration->ticket_ID()
-                )
-            );
-        }
-        $registration->set_final_price($ticket->price());
-        if ($update_reg) {
-            $registration->save();
-        }
-        return true;
-    }
+	private static ?EE_Registration_Processor $_instance = null;
+
+	protected RequestInterface $request;
+
+	/**
+	 * initial reg status at the beginning of this request.
+	 * indexed by registration ID
+	 *
+	 * @var array
+	 */
+	protected array $_old_reg_status = [];
+
+	/**
+	 * reg status at the end of the request after all processing.
+	 * indexed by registration ID
+	 *
+	 * @var array
+	 */
+	protected array $_new_reg_status = [];
+
+	/**
+	 * amounts paid at the end of the request after all processing.
+	 * indexed by registration ID
+	 *
+	 * @var array
+	 */
+	protected static array $_amount_paid = [];
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param RequestInterface|null $request
+	 * @return EE_Registration_Processor instance
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function instance(RequestInterface $request = null): EE_Registration_Processor
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Registration_Processor) {
+			if (! $request instanceof RequestInterface) {
+				$request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
+			}
+			self::$_instance = new self($request);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * EE_Registration_Processor constructor.
+	 *
+	 * @param RequestInterface $request
+	 */
+	public function __construct(RequestInterface $request)
+	{
+		$this->request = $request;
+	}
+
+
+	/**
+	 * @param int $REG_ID
+	 * @return string
+	 */
+	public function old_reg_status(int $REG_ID): ?string
+	{
+		return $this->_old_reg_status[ $REG_ID ] ?? null;
+	}
+
+
+	/**
+	 * @param int    $REG_ID
+	 * @param string $old_reg_status
+	 */
+	public function set_old_reg_status(int $REG_ID, string $old_reg_status)
+	{
+		// only set the first time
+		if (! isset($this->_old_reg_status[ $REG_ID ])) {
+			$this->_old_reg_status[ $REG_ID ] = $old_reg_status;
+		}
+	}
+
+
+	/**
+	 * @param int $REG_ID
+	 * @return string
+	 */
+	public function new_reg_status(int $REG_ID): ?string
+	{
+		return $this->_new_reg_status[ $REG_ID ] ?? null;
+	}
+
+
+	/**
+	 * @param int    $REG_ID
+	 * @param string $new_reg_status
+	 */
+	public function set_new_reg_status(int $REG_ID, string $new_reg_status)
+	{
+		$this->_new_reg_status[ $REG_ID ] = $new_reg_status;
+	}
+
+
+	/**
+	 * @param int $REG_ID
+	 * @return bool
+	 */
+	public function reg_status_updated(int $REG_ID): bool
+	{
+		return $this->new_reg_status($REG_ID) !== $this->old_reg_status($REG_ID);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function update_registration_status_and_trigger_notifications(EE_Registration $registration)
+	{
+		$this->toggle_incomplete_registration_status_to_default(
+			$registration,
+			false,
+			new Context(
+				__METHOD__,
+				esc_html__(
+					'Executed when the registration status is updated during the registration process just prior to triggering notifications.',
+					'event_espresso'
+				)
+			)
+		);
+		$this->toggle_registration_status_for_default_approved_events($registration, false);
+		$this->toggle_registration_status_if_no_monies_owing($registration, false);
+		$registration->save();
+		// trigger notifications
+		$this->trigger_registration_update_notifications($registration);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param string          $new_reg_status
+	 * @param bool            $save            TRUE will save the registration if the status is updated,
+	 *                                         FALSE will leave that up to client code
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function manually_update_registration_status(
+		EE_Registration $registration,
+		string $new_reg_status = '',
+		bool $save = true
+	): bool {
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
+		// set incoming REG_Status
+		$this->set_new_reg_status($registration->ID(), $new_reg_status);
+		// toggle reg status but only if it has changed and the user can do so
+		if (
+			$this->reg_status_updated($registration->ID())
+			&& (
+				(! $this->request->isAdmin() || $this->request->isFrontAjax())
+				|| EE_Registry::instance()->CAP->current_user_can(
+					'ee_edit_registration',
+					'toggle_registration_status',
+					$registration->ID()
+				)
+			)
+		) {
+			// change status to new value
+			$updated = $registration->set_status(
+				$this->new_reg_status($registration->ID()),
+				false,
+				new Context(
+					__METHOD__,
+					esc_html__(
+						'Executed when the registration status is manually updated during the reg process.',
+						'event_espresso'
+					)
+				)
+			);
+			if ($updated && $save) {
+				$registration->save();
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * changes any incomplete registrations to either the event or global default registration status
+	 *
+	 * @param EE_Registration       $registration
+	 * @param bool                  $save           TRUE will save the registration if the status is updated,
+	 *                                              FALSE will leave that up to client code
+	 * @param ContextInterface|null $context
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function toggle_incomplete_registration_status_to_default(
+		EE_Registration $registration,
+		bool $save = true,
+		?ContextInterface $context = null
+	) {
+		$existing_reg_status = $registration->status_ID();
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $existing_reg_status);
+		// is the registration currently incomplete ?
+		if ($registration->status_ID() === RegStatus::INCOMPLETE) {
+			// grab default reg status for the event, if set
+			$event_default_registration_status = $registration->defaultRegistrationStatus();
+			// if no default reg status is set for the event, then use the global value
+			$STS_ID = ! empty($event_default_registration_status)
+				? $event_default_registration_status
+				: EE_Registry::instance()->CFG->registration->default_STS_ID;
+			// if the event default reg status is approved, then downgrade temporarily to payment pending to ensure that payments are triggered
+			$STS_ID = $STS_ID === RegStatus::APPROVED
+				? RegStatus::PENDING_PAYMENT
+				: $STS_ID;
+			// set incoming REG_Status
+			$this->set_new_reg_status($registration->ID(), $STS_ID);
+			$context = $context instanceof ContextInterface
+				? $context
+				: new Context(
+					__METHOD__,
+					esc_html__(
+						'Executed when the registration status is updated to the default reg status during the registration process.',
+						'event_espresso'
+					)
+				);
+			$registration->set_status($STS_ID, false, $context);
+			if ($save) {
+				$registration->save();
+			}
+			// don't trigger notifications during IPNs because they will get triggered by
+			// EventEspresso\core\services\payments\PostPaymentProcessor
+			if (! EE_Processor_Base::$IPN) {
+				// otherwise, send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+			}
+			// DEBUG LOG
+			// $this->log(
+			//     __CLASS__,
+			//     __FUNCTION__,
+			//     __LINE__,
+			//     $registration->transaction(),
+			//     array(
+			//         'IPN' => EE_Processor_Base::$IPN,
+			//         'deliver_notifications' => has_filter(
+			//             'FHEE__EED_Messages___maybe_registration__deliver_notifications'
+			//         ),
+			//     )
+			// );
+		}
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param bool            $save         TRUE will save the registration if the status is updated,
+	 *                                      FALSE will leave that up to client code
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function toggle_registration_status_for_default_approved_events(
+		EE_Registration $registration,
+		bool $save = true
+	): bool {
+		$reg_status = $registration->status_ID();
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $reg_status);
+		// if not already, toggle reg status to approved IF the event default reg status is approved
+		// ( as long as the registration wasn't cancelled or declined at some point )
+		if (
+			$reg_status !== RegStatus::CANCELLED
+			&& $reg_status !== RegStatus::DECLINED
+			&& $reg_status !== RegStatus::APPROVED
+			&& $registration->defaultRegistrationStatus() === RegStatus::APPROVED
+		) {
+			// set incoming REG_Status
+			$this->set_new_reg_status($registration->ID(), RegStatus::APPROVED);
+			// toggle status to approved
+			$registration->set_status(
+				RegStatus::APPROVED,
+				false,
+				new Context(
+					__METHOD__,
+					esc_html__(
+						'Executed when the registration status is updated for events with a default reg status of RegStatus::APPROVED.',
+						'event_espresso'
+					)
+				)
+			);
+			if ($save) {
+				$registration->save();
+			}
+			// don't trigger notifications during IPNs because they will get triggered by
+			// EventEspresso\core\services\payments\PostPaymentProcessor
+			if (! EE_Processor_Base::$IPN) {
+				// otherwise, send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+			}
+			// DEBUG LOG
+			// $this->log(
+			//     __CLASS__,
+			//     __FUNCTION__,
+			//     __LINE__,
+			//     $registration->transaction(),
+			//     array(
+			//         'IPN' => EE_Processor_Base::$IPN,
+			//         'deliver_notifications' => has_filter(
+			//             'FHEE__EED_Messages___maybe_registration__deliver_notifications'
+			//         ),
+			//     )
+			// );
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 *    toggle_registration_statuses_if_no_monies_owing
+	 *
+	 * @param EE_Registration $registration
+	 * @param bool            $save                 TRUE will save the registration if the status is updated,
+	 *                                              FALSE will leave that up to client code
+	 * @param array           $additional_details
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function toggle_registration_status_if_no_monies_owing(
+		EE_Registration $registration,
+		bool $save = true,
+		array $additional_details = []
+	): bool {
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
+		// was a payment just made ?
+		$payment    = isset($additional_details['payment_updates'], $additional_details['last_payment'])
+		&& $additional_details['payment_updates']
+		&& $additional_details['last_payment'] instanceof EE_Payment
+			? $additional_details['last_payment']
+			: null;
+		$total_paid = array_sum(self::$_amount_paid);
+		// toggle reg status to approved IF
+		if (
+			// REG status is pending payment
+			$registration->status_ID() === RegStatus::PENDING_PAYMENT
+			// AND no monies are owing
+			&& (
+				(
+					$registration->transaction()->is_completed()
+					|| $registration->transaction()->is_overpaid()
+					|| $registration->transaction()->is_free()
+					|| apply_filters(
+						'FHEE__EE_Registration_Processor__toggle_registration_status_if_no_monies_owing',
+						false,
+						$registration
+					)
+				)
+				|| (
+					$payment instanceof EE_Payment && $payment->is_approved()
+					// this specific registration has not yet been paid for
+					&& ! isset(self::$_amount_paid[ $registration->ID() ])
+					// payment amount, less what we have already attributed to other registrations,
+					// is greater than this registration's final price
+					&& $payment->amount() - $total_paid >= $registration->final_price()
+				)
+			)
+		) {
+			// mark as paid
+			self::$_amount_paid[ $registration->ID() ] = $registration->final_price();
+			// track new REG_Status
+			$this->set_new_reg_status($registration->ID(), RegStatus::APPROVED);
+			// toggle status to approved
+			$registration->set_status(
+				RegStatus::APPROVED,
+				false,
+				new Context(
+					__METHOD__,
+					esc_html__(
+						'Executed when the registration status is updated to RegStatus::APPROVED when no monies are owing.',
+						'event_espresso'
+					)
+				)
+			);
+			if ($save) {
+				$registration->save();
+			}
+			// don't trigger notifications during IPNs because they will get triggered by
+			// EventEspresso\core\services\payments\PostPaymentProcessor
+			if (! EE_Processor_Base::$IPN) {
+				// otherwise, send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+			}
+			// DEBUG LOG
+			// $this->log(
+			//     __CLASS__,
+			//     __FUNCTION__,
+			//     __LINE__,
+			//     $registration->transaction(),
+			//     array(
+			//         'IPN' => EE_Processor_Base::$IPN,
+			//         'deliver_notifications' => has_filter(
+			//             'FHEE__EED_Messages___maybe_registration__deliver_notifications'
+			//         ),
+			//     )
+			// );
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * @param EE_Registration|null $registration
+	 * @param array                $additional_details
+	 * @return void
+	 */
+	public function trigger_registration_update_notifications(
+		?EE_Registration $registration,
+		array $additional_details = []
+	) {
+		try {
+			if (! $registration instanceof EE_Registration) {
+				throw new EE_Error(
+					esc_html__('An invalid registration was received.', 'event_espresso')
+				);
+			}
+			// EE_Registry::instance()->load_helper('Debug_Tools');
+			// EEH_Debug_Tools::log(
+			//     __CLASS__,
+			//     __FUNCTION__,
+			//     __LINE__,
+			//     array($registration->transaction(), $additional_details),
+			//     false,
+			//     'EE_Transaction: ' . $registration->transaction()->ID()
+			// );
+			if (
+				! $this->request->getRequestParam('non_primary_reg_notification', 0, 'int')
+				&& ! $registration->is_primary_registrant()
+			) {
+				return;
+			}
+			do_action(
+				'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
+				$registration,
+				$additional_details
+			);
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), $e->getFile(), 'unknown_function_from_exception', $e->getLine());
+		}
+	}
+
+
+	/**
+	 * sets reg status based either on passed param or on transaction status and event pre-approval setting
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $additional_details
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function update_registration_after_checkout_or_payment(
+		EE_Registration $registration,
+		array $additional_details = []
+	): bool {
+		// set initial REG_Status
+		$this->set_old_reg_status($registration->ID(), $registration->status_ID());
+		// if the registration status gets updated, then save the registration
+		if (
+			$this->toggle_registration_status_for_default_approved_events($registration, false)
+			|| $this->toggle_registration_status_if_no_monies_owing(
+				$registration,
+				false,
+				$additional_details
+			)
+		) {
+			$registration->save();
+		}
+		// set new  REG_Status
+		$this->set_new_reg_status($registration->ID(), $registration->status_ID());
+		return $this->reg_status_updated($registration->ID())
+			&& $this->new_reg_status($registration->ID()) === RegStatus::APPROVED;
+	}
+
+
+	/**
+	 * Updates the registration' final prices based on the current line item tree (taking into account
+	 * discounts, taxes, and other line items unrelated to tickets.)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param boolean        $save_regs whether to immediately save registrations in this function or not
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	public function update_registration_final_prices(EE_Transaction $transaction, bool $save_regs = true)
+	{
+		$reg_final_price_per_ticket_line_item = EEH_Line_Item::calculate_reg_final_prices_per_line_item(
+			$transaction->total_line_item()
+		);
+		foreach ($transaction->registrations() as $registration) {
+			/** @var EE_Line_Item $line_item */
+			$line_item = EEM_Line_Item::instance()->get_line_item_for_registration($registration);
+			if (isset($reg_final_price_per_ticket_line_item[ $line_item->ID() ])) {
+				$registration->set_final_price($reg_final_price_per_ticket_line_item[ $line_item->ID() ]);
+				if ($save_regs) {
+					$registration->save();
+				}
+			}
+		}
+		// and make sure there's no rounding problem
+		$this->fix_reg_final_price_rounding_issue($transaction);
+	}
+
+
+	/**
+	 * Makes sure there is no rounding errors for the REG_final_prices.
+	 * Eg, if we have 3 registrations for $1, and there is a $0.01 discount between the three of them,
+	 * they will each be for $0.99333333, which gets rounded to $1 again.
+	 * So the transaction total will be $2.99, but each registration will be for $1,
+	 * so if each registrant paid individually they will have overpaid by $0.01.
+	 * So in order to overcome this, we check for any difference, and if there is a difference
+	 * we just grab one registrant at random and make them responsible for it.
+	 * This should be used after setting REG_final_prices (it's done automatically as part of
+	 * EE_Registration_Processor::update_registration_final_prices())
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return bool success verifying that there is NO difference after this method is done
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function fix_reg_final_price_rounding_issue(EE_Transaction $transaction): bool
+	{
+		$reg_final_price_sum = EEM_Registration::instance()->sum(
+			[
+				[
+					'TXN_ID' => $transaction->ID(),
+				],
+			],
+			'REG_final_price'
+		);
+		$diff                = $transaction->total() - $reg_final_price_sum;
+		// ok then, just grab one of the registrations
+		if ($diff !== 0.0) {
+			$a_reg = EEM_Registration::instance()->get_one(
+				[
+					[
+						'TXN_ID' => $transaction->ID(),
+					],
+				]
+			);
+			return $a_reg instanceof EE_Registration
+				&& $a_reg->save(['REG_final_price' => $a_reg->final_price() + $diff]);
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param array           $closed_reg_statuses
+	 * @param bool            $update_reg
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	public function update_registration_after_being_canceled_or_declined(
+		EE_Registration $registration,
+		array $closed_reg_statuses = [],
+		bool $update_reg = true
+	): bool {
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses)
+			? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+			return false;
+		}
+		// release a reserved ticket by decrementing ticket and datetime reserved values
+		$registration->release_reserved_ticket(true, 'RegProcessor:' . __LINE__);
+		$registration->set_final_price(0);
+		if ($update_reg) {
+			$registration->save();
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param array           $closed_reg_statuses
+	 * @param bool            $update_reg
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 * @throws ReflectionException
+	 */
+	public function update_canceled_or_declined_registration_after_being_reinstated(
+		EE_Registration $registration,
+		array $closed_reg_statuses = [],
+		bool $update_reg = true
+	): bool {
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+			return false;
+		}
+		$ticket = $registration->ticket();
+		if (! $ticket instanceof EE_Ticket) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The Ticket for Registration %1$d was not found or is invalid.',
+						'event_espresso'
+					),
+					$registration->ticket_ID()
+				)
+			);
+		}
+		$registration->set_final_price($ticket->price());
+		if ($update_reg) {
+			$registration->save();
+		}
+		return true;
+	}
 }

Spacing +22 added lines, -22 removed lines

@@ -9,7 +9,7 @@ 
 use EventEspresso\core\services\loaders\LoaderFactory;
 use EventEspresso\core\services\request\RequestInterface;
 
-require_once __DIR__ . '/EE_Processor_Base.class.php';
+require_once __DIR__.'/EE_Processor_Base.class.php';
 
 /**
  * Class EE_Registration_Processor
@@ -62,8 +62,8 @@ 
     public static function instance(RequestInterface $request = null): EE_Registration_Processor
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Registration_Processor) {
-            if (! $request instanceof RequestInterface) {
+        if ( ! self::$_instance instanceof EE_Registration_Processor) {
+            if ( ! $request instanceof RequestInterface) {
                 $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
             }
             self::$_instance = new self($request);
@@ -89,7 +89,7 @@ 
      */
     public function old_reg_status(int $REG_ID): ?string
     {
-        return $this->_old_reg_status[ $REG_ID ] ?? null;
+        return $this->_old_reg_status[$REG_ID] ?? null;
     }
 
 
@@ -100,8 +100,8 @@ 
     public function set_old_reg_status(int $REG_ID, string $old_reg_status)
     {
         // only set the first time
-        if (! isset($this->_old_reg_status[ $REG_ID ])) {
-            $this->_old_reg_status[ $REG_ID ] = $old_reg_status;
+        if ( ! isset($this->_old_reg_status[$REG_ID])) {
+            $this->_old_reg_status[$REG_ID] = $old_reg_status;
         }
     }
 
@@ -112,7 +112,7 @@ 
      */
     public function new_reg_status(int $REG_ID): ?string
     {
-        return $this->_new_reg_status[ $REG_ID ] ?? null;
+        return $this->_new_reg_status[$REG_ID] ?? null;
     }
 
 
@@ -122,7 +122,7 @@ 
      */
     public function set_new_reg_status(int $REG_ID, string $new_reg_status)
     {
-        $this->_new_reg_status[ $REG_ID ] = $new_reg_status;
+        $this->_new_reg_status[$REG_ID] = $new_reg_status;
     }
 
 
@@ -194,7 +194,7 @@ 
         if (
             $this->reg_status_updated($registration->ID())
             && (
-                (! $this->request->isAdmin() || $this->request->isFrontAjax())
+                ( ! $this->request->isAdmin() || $this->request->isFrontAjax())
                 || EE_Registry::instance()->CAP->current_user_can(
                     'ee_edit_registration',
                     'toggle_registration_status',
@@ -276,7 +276,7 @@ 
             }
             // don't trigger notifications during IPNs because they will get triggered by
             // EventEspresso\core\services\payments\PostPaymentProcessor
-            if (! EE_Processor_Base::$IPN) {
+            if ( ! EE_Processor_Base::$IPN) {
                 // otherwise, send out notifications
                 add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
             }
@@ -344,7 +344,7 @@ 
             }
             // don't trigger notifications during IPNs because they will get triggered by
             // EventEspresso\core\services\payments\PostPaymentProcessor
-            if (! EE_Processor_Base::$IPN) {
+            if ( ! EE_Processor_Base::$IPN) {
                 // otherwise, send out notifications
                 add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
             }
@@ -391,7 +391,7 @@ 
         // set initial REG_Status
         $this->set_old_reg_status($registration->ID(), $registration->status_ID());
         // was a payment just made ?
-        $payment    = isset($additional_details['payment_updates'], $additional_details['last_payment'])
+        $payment = isset($additional_details['payment_updates'], $additional_details['last_payment'])
         && $additional_details['payment_updates']
         && $additional_details['last_payment'] instanceof EE_Payment
             ? $additional_details['last_payment']
@@ -416,7 +416,7 @@ 
                 || (
                     $payment instanceof EE_Payment && $payment->is_approved()
                     // this specific registration has not yet been paid for
-                    && ! isset(self::$_amount_paid[ $registration->ID() ])
+                    && ! isset(self::$_amount_paid[$registration->ID()])
                     // payment amount, less what we have already attributed to other registrations,
                     // is greater than this registration's final price
                     && $payment->amount() - $total_paid >= $registration->final_price()
@@ -424,7 +424,7 @@ 
             )
         ) {
             // mark as paid
-            self::$_amount_paid[ $registration->ID() ] = $registration->final_price();
+            self::$_amount_paid[$registration->ID()] = $registration->final_price();
             // track new REG_Status
             $this->set_new_reg_status($registration->ID(), RegStatus::APPROVED);
             // toggle status to approved
@@ -444,7 +444,7 @@ 
             }
             // don't trigger notifications during IPNs because they will get triggered by
             // EventEspresso\core\services\payments\PostPaymentProcessor
-            if (! EE_Processor_Base::$IPN) {
+            if ( ! EE_Processor_Base::$IPN) {
                 // otherwise, send out notifications
                 add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
             }
@@ -477,7 +477,7 @@ 
         array $additional_details = []
     ) {
         try {
-            if (! $registration instanceof EE_Registration) {
+            if ( ! $registration instanceof EE_Registration) {
                 throw new EE_Error(
                     esc_html__('An invalid registration was received.', 'event_espresso')
                 );
@@ -568,8 +568,8 @@ 
         foreach ($transaction->registrations() as $registration) {
             /** @var EE_Line_Item $line_item */
             $line_item = EEM_Line_Item::instance()->get_line_item_for_registration($registration);
-            if (isset($reg_final_price_per_ticket_line_item[ $line_item->ID() ])) {
-                $registration->set_final_price($reg_final_price_per_ticket_line_item[ $line_item->ID() ]);
+            if (isset($reg_final_price_per_ticket_line_item[$line_item->ID()])) {
+                $registration->set_final_price($reg_final_price_per_ticket_line_item[$line_item->ID()]);
                 if ($save_regs) {
                     $registration->save();
                 }
@@ -609,7 +609,7 @@ 
             ],
             'REG_final_price'
         );
-        $diff                = $transaction->total() - $reg_final_price_sum;
+        $diff = $transaction->total() - $reg_final_price_sum;
         // ok then, just grab one of the registrations
         if ($diff !== 0.0) {
             $a_reg = EEM_Registration::instance()->get_one(
@@ -644,11 +644,11 @@ 
         $closed_reg_statuses = ! empty($closed_reg_statuses)
             ? $closed_reg_statuses
             : EEM_Registration::closed_reg_statuses();
-        if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+        if ( ! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
             return false;
         }
         // release a reserved ticket by decrementing ticket and datetime reserved values
-        $registration->release_reserved_ticket(true, 'RegProcessor:' . __LINE__);
+        $registration->release_reserved_ticket(true, 'RegProcessor:'.__LINE__);
         $registration->set_final_price(0);
         if ($update_reg) {
             $registration->save();
@@ -678,7 +678,7 @@ 
             return false;
         }
         $ticket = $registration->ticket();
-        if (! $ticket instanceof EE_Ticket) {
+        if ( ! $ticket instanceof EE_Ticket) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(

core/business/EE_Transaction_Payments.class.php

Indentation +228 added lines, -228 removed lines

@@ -14,250 +14,250 @@
  */
 class EE_Transaction_Payments
 {
-    private static ?EE_Transaction_Payments $_instance = null;
+	private static ?EE_Transaction_Payments $_instance = null;
 
 
-    /**
-     * @singleton method used to instantiate class object
-     * @return EE_Transaction_Payments instance
-     */
-    public static function instance(): EE_Transaction_Payments
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Transaction_Payments) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
+	/**
+	 * @singleton method used to instantiate class object
+	 * @return EE_Transaction_Payments instance
+	 */
+	public static function instance(): EE_Transaction_Payments
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Transaction_Payments) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
 
 
-    /**
-     * @param EE_Transaction $transaction
-     * @param bool           $update_txn
-     * @return bool true if TXN total was updated, false if not
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function recalculate_transaction_total(EE_Transaction $transaction, bool $update_txn = true): bool
-    {
-        $total_line_item = $transaction->total_line_item();
-        if (! $total_line_item instanceof EE_Line_Item) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The Total Line Item for Transaction %1$d\'s was not found or is invalid.',
-                        'event_espresso'
-                    ),
-                    $transaction->ID()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $new_total = $total_line_item->recalculate_total_including_taxes();
-        $transaction->set_total($new_total);
-        if ($update_txn) {
-            return (bool) $transaction->save();
-        }
-        return false;
-    }
+	/**
+	 * @param EE_Transaction $transaction
+	 * @param bool           $update_txn
+	 * @return bool true if TXN total was updated, false if not
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function recalculate_transaction_total(EE_Transaction $transaction, bool $update_txn = true): bool
+	{
+		$total_line_item = $transaction->total_line_item();
+		if (! $total_line_item instanceof EE_Line_Item) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The Total Line Item for Transaction %1$d\'s was not found or is invalid.',
+						'event_espresso'
+					),
+					$transaction->ID()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$new_total = $total_line_item->recalculate_total_including_taxes();
+		$transaction->set_total($new_total);
+		if ($update_txn) {
+			return (bool) $transaction->save();
+		}
+		return false;
+	}
 
 
-    /**
-     * Updates the provided EE_Transaction with all the applicable payments
-     * returns a boolean for whether the TXN was saved to the db
-     * (meaning a status change occurred)
-     * or not saved (which could **still** mean that
-     * the TXN status changed, but just was not yet saved).
-     * So if passing a value of false for the $update_txn param,
-     * then client code needs to take responsibility for saving the TXN
-     * regardless of what happens within EE_Transaction_Payments;
-     *
-     * @param EE_Transaction $transaction
-     * @param boolean        $update_txn whether to save the TXN
-     * @return    boolean        whether the TXN was saved
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function calculate_total_payments_and_update_status(
-        EE_Transaction $transaction,
-        bool $update_txn = true
-    ): bool {
-        // calculate total paid
-        $total_paid = $this->recalculate_total_payments_for_transaction($transaction);
-        // if total paid has changed
-        if (EEH_Money::compare_floats($total_paid, $transaction->paid(), '!==')) {
-            $transaction->set_paid($total_paid);
-            // maybe update status, and make sure to save transaction if not done already
-            if (! $transaction->update_status_based_on_total_paid($update_txn)) {
-                if ($update_txn) {
-                    return (bool) $transaction->save();
-                }
-            } else {
-                // the status got updated and was saved by
-                // update_transaction_status_based_on_total_paid()
-                return true;
-            }
-        }
-        return false;
-    }
+	/**
+	 * Updates the provided EE_Transaction with all the applicable payments
+	 * returns a boolean for whether the TXN was saved to the db
+	 * (meaning a status change occurred)
+	 * or not saved (which could **still** mean that
+	 * the TXN status changed, but just was not yet saved).
+	 * So if passing a value of false for the $update_txn param,
+	 * then client code needs to take responsibility for saving the TXN
+	 * regardless of what happens within EE_Transaction_Payments;
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param boolean        $update_txn whether to save the TXN
+	 * @return    boolean        whether the TXN was saved
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function calculate_total_payments_and_update_status(
+		EE_Transaction $transaction,
+		bool $update_txn = true
+	): bool {
+		// calculate total paid
+		$total_paid = $this->recalculate_total_payments_for_transaction($transaction);
+		// if total paid has changed
+		if (EEH_Money::compare_floats($total_paid, $transaction->paid(), '!==')) {
+			$transaction->set_paid($total_paid);
+			// maybe update status, and make sure to save transaction if not done already
+			if (! $transaction->update_status_based_on_total_paid($update_txn)) {
+				if ($update_txn) {
+					return (bool) $transaction->save();
+				}
+			} else {
+				// the status got updated and was saved by
+				// update_transaction_status_based_on_total_paid()
+				return true;
+			}
+		}
+		return false;
+	}
 
 
-    /**
-     * @param EE_Transaction $transaction
-     * @param string         $payment_status One of EEM_Payment's statuses, like 'PAP' (Approved).
-     *                                       By default, searches for approved payments
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function recalculate_total_payments_for_transaction(
-        EE_Transaction $transaction,
-        string $payment_status = EEM_Payment::status_id_approved
-    ): float {
-        // ensure Payment model is loaded
-        EE_Registry::instance()->load_model('Payment');
-        // calls EEM_Base::sum()
-        return EEM_Payment::instance()->sum(
-        // query params
-            [['TXN_ID' => $transaction->ID(), 'STS_ID' => $payment_status]],
-            // field to sum
-            'PAY_amount'
-        );
-    }
+	/**
+	 * @param EE_Transaction $transaction
+	 * @param string         $payment_status One of EEM_Payment's statuses, like 'PAP' (Approved).
+	 *                                       By default, searches for approved payments
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function recalculate_total_payments_for_transaction(
+		EE_Transaction $transaction,
+		string $payment_status = EEM_Payment::status_id_approved
+	): float {
+		// ensure Payment model is loaded
+		EE_Registry::instance()->load_model('Payment');
+		// calls EEM_Base::sum()
+		return EEM_Payment::instance()->sum(
+		// query params
+			[['TXN_ID' => $transaction->ID(), 'STS_ID' => $payment_status]],
+			// field to sum
+			'PAY_amount'
+		);
+	}
 
 
-    /**
-     * Before deleting the selected payment, we fetch its transaction,
-     * then delete the payment, and update the transactions' amount paid.
-     *
-     * @param EE_Payment $payment
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_payment_and_update_transaction(EE_Payment $payment): bool
-    {
-        if (! $this->delete_registration_payments_and_update_registrations($payment)) {
-            return false;
-        }
-        if (! $payment->delete()) {
-            EE_Error::add_error(
-                esc_html__('The payment could not be deleted.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
+	/**
+	 * Before deleting the selected payment, we fetch its transaction,
+	 * then delete the payment, and update the transactions' amount paid.
+	 *
+	 * @param EE_Payment $payment
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_payment_and_update_transaction(EE_Payment $payment): bool
+	{
+		if (! $this->delete_registration_payments_and_update_registrations($payment)) {
+			return false;
+		}
+		if (! $payment->delete()) {
+			EE_Error::add_error(
+				esc_html__('The payment could not be deleted.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
 
-        $transaction = $payment->transaction();
-        $TXN_status  = $transaction->status_ID();
-        if (
-            $TXN_status === EEM_Transaction::abandoned_status_code
-            || $TXN_status === EEM_Transaction::failed_status_code
-            || $payment->amount() == 0.0
-        ) {
-            EE_Error::add_success(esc_html__('The Payment was successfully deleted.', 'event_espresso'));
-            return true;
-        }
+		$transaction = $payment->transaction();
+		$TXN_status  = $transaction->status_ID();
+		if (
+			$TXN_status === EEM_Transaction::abandoned_status_code
+			|| $TXN_status === EEM_Transaction::failed_status_code
+			|| $payment->amount() == 0.0
+		) {
+			EE_Error::add_success(esc_html__('The Payment was successfully deleted.', 'event_espresso'));
+			return true;
+		}
 
 
-        // if this fails, that just means that the transaction didn't get its status changed and/or updated.
-        // however the payment was still deleted.
-        if (! $this->calculate_total_payments_and_update_status($transaction)) {
-            EE_Error::add_attention(
-                esc_html__(
-                    'It appears that the Payment was deleted but no change was recorded for the Transaction for an unknown reason. Please verify that all data for this Transaction looks correct..',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return true;
-        }
+		// if this fails, that just means that the transaction didn't get its status changed and/or updated.
+		// however the payment was still deleted.
+		if (! $this->calculate_total_payments_and_update_status($transaction)) {
+			EE_Error::add_attention(
+				esc_html__(
+					'It appears that the Payment was deleted but no change was recorded for the Transaction for an unknown reason. Please verify that all data for this Transaction looks correct..',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return true;
+		}
 
-        EE_Error::add_success(
-            esc_html__(
-                'The Payment was successfully deleted, and the Transaction has been updated accordingly.',
-                'event_espresso'
-            )
-        );
-        return true;
-    }
+		EE_Error::add_success(
+			esc_html__(
+				'The Payment was successfully deleted, and the Transaction has been updated accordingly.',
+				'event_espresso'
+			)
+		);
+		return true;
+	}
 
 
-    /**
-     * removes all registration payment records associated with a payment
-     * and subtracts their amounts from the corresponding registrations REG_paid field
-     *
-     * @param EE_Payment $payment
-     * @param array      $reg_payment_query_params
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_registration_payments_and_update_registrations(
-        EE_Payment $payment,
-        array $reg_payment_query_params = []
-    ): bool {
-        $save_payment             = false;
-        $reg_payment_query_params = ! empty($reg_payment_query_params)
-            ? $reg_payment_query_params
-            : [['PAY_ID' => $payment->ID()]];
-        $registration_payments    = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params);
-        if (! empty($registration_payments)) {
-            foreach ($registration_payments as $registration_payment) {
-                if ($registration_payment instanceof EE_Registration_Payment) {
-                    $amount_paid  = $registration_payment->amount();
-                    $registration = $registration_payment->registration();
-                    if ($registration instanceof EE_Registration) {
-                        $registration->set_paid($registration->paid() - $amount_paid);
-                        if ($registration->save() !== false) {
-                            $registration_payment->delete_permanently();
-                            $save_payment = true;
-                        }
-                    } else {
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    'An invalid Registration object was associated with Registration Payment ID# %1$d.',
-                                    'event_espresso'
-                                ),
-                                $registration_payment->ID()
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return false;
-                    }
-                } else {
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__(
-                                'An invalid Registration Payment object was associated with payment ID# %1$d.',
-                                'event_espresso'
-                            ),
-                            $payment->ID()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                }
-            }
-        }
-        if ($save_payment) {
-            $payment->save();
-        }
-        return true;
-    }
+	/**
+	 * removes all registration payment records associated with a payment
+	 * and subtracts their amounts from the corresponding registrations REG_paid field
+	 *
+	 * @param EE_Payment $payment
+	 * @param array      $reg_payment_query_params
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_registration_payments_and_update_registrations(
+		EE_Payment $payment,
+		array $reg_payment_query_params = []
+	): bool {
+		$save_payment             = false;
+		$reg_payment_query_params = ! empty($reg_payment_query_params)
+			? $reg_payment_query_params
+			: [['PAY_ID' => $payment->ID()]];
+		$registration_payments    = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params);
+		if (! empty($registration_payments)) {
+			foreach ($registration_payments as $registration_payment) {
+				if ($registration_payment instanceof EE_Registration_Payment) {
+					$amount_paid  = $registration_payment->amount();
+					$registration = $registration_payment->registration();
+					if ($registration instanceof EE_Registration) {
+						$registration->set_paid($registration->paid() - $amount_paid);
+						if ($registration->save() !== false) {
+							$registration_payment->delete_permanently();
+							$save_payment = true;
+						}
+					} else {
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									'An invalid Registration object was associated with Registration Payment ID# %1$d.',
+									'event_espresso'
+								),
+								$registration_payment->ID()
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return false;
+					}
+				} else {
+					EE_Error::add_error(
+						sprintf(
+							esc_html__(
+								'An invalid Registration Payment object was associated with payment ID# %1$d.',
+								'event_espresso'
+							),
+							$payment->ID()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+				}
+			}
+		}
+		if ($save_payment) {
+			$payment->save();
+		}
+		return true;
+	}
 
 
-    /********************************** DEPRECATED METHODS **********************************/
+	/********************************** DEPRECATED METHODS **********************************/
 }

Spacing +7 added lines, -7 removed lines

@@ -24,7 +24,7 @@ 
     public static function instance(): EE_Transaction_Payments
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Transaction_Payments) {
+        if ( ! self::$_instance instanceof EE_Transaction_Payments) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -41,7 +41,7 @@ 
     public function recalculate_transaction_total(EE_Transaction $transaction, bool $update_txn = true): bool
     {
         $total_line_item = $transaction->total_line_item();
-        if (! $total_line_item instanceof EE_Line_Item) {
+        if ( ! $total_line_item instanceof EE_Line_Item) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -91,7 +91,7 @@ 
         if (EEH_Money::compare_floats($total_paid, $transaction->paid(), '!==')) {
             $transaction->set_paid($total_paid);
             // maybe update status, and make sure to save transaction if not done already
-            if (! $transaction->update_status_based_on_total_paid($update_txn)) {
+            if ( ! $transaction->update_status_based_on_total_paid($update_txn)) {
                 if ($update_txn) {
                     return (bool) $transaction->save();
                 }
@@ -140,10 +140,10 @@ 
      */
     public function delete_payment_and_update_transaction(EE_Payment $payment): bool
     {
-        if (! $this->delete_registration_payments_and_update_registrations($payment)) {
+        if ( ! $this->delete_registration_payments_and_update_registrations($payment)) {
             return false;
         }
-        if (! $payment->delete()) {
+        if ( ! $payment->delete()) {
             EE_Error::add_error(
                 esc_html__('The payment could not be deleted.', 'event_espresso'),
                 __FILE__,
@@ -167,7 +167,7 @@ 
 
         // if this fails, that just means that the transaction didn't get its status changed and/or updated.
         // however the payment was still deleted.
-        if (! $this->calculate_total_payments_and_update_status($transaction)) {
+        if ( ! $this->calculate_total_payments_and_update_status($transaction)) {
             EE_Error::add_attention(
                 esc_html__(
                     'It appears that the Payment was deleted but no change was recorded for the Transaction for an unknown reason. Please verify that all data for this Transaction looks correct..',
@@ -209,7 +209,7 @@ 
             ? $reg_payment_query_params
             : [['PAY_ID' => $payment->ID()]];
         $registration_payments    = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params);
-        if (! empty($registration_payments)) {
+        if ( ! empty($registration_payments)) {
             foreach ($registration_payments as $registration_payment) {
                 if ($registration_payment instanceof EE_Registration_Payment) {
                     $amount_paid  = $registration_payment->amount();

core/business/EE_Transaction_Processor.class.php

Indentation +586 added lines, -586 removed lines

@@ -16,590 +16,590 @@
  */
 class EE_Transaction_Processor extends EE_Processor_Base
 {
-    private static ?EE_Transaction_Processor $_instance = null;
-
-    /**
-     * array of query WHERE params to use when retrieving cached registrations from a transaction
-     *
-     * @var array $registration_query_params
-     */
-    private array $_registration_query_params = [];
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param array $registration_query_params
-     * @return EE_Transaction_Processor instance
-     */
-    public static function instance(array $registration_query_params = []): EE_Transaction_Processor
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Transaction_Processor) {
-            self::$_instance = new self($registration_query_params);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @param array $registration_query_params
-     */
-    private function __construct(array $registration_query_params = [])
-    {
-        // make sure some query params are set for retrieving registrations
-        $this->_set_registration_query_params($registration_query_params);
-    }
-
-
-    /**
-     * @param array $registration_query_params
-     */
-    private function _set_registration_query_params(array $registration_query_params)
-    {
-        $this->_registration_query_params = ! empty($registration_query_params)
-            ? $registration_query_params
-            : ['order_by' => ['REG_count' => 'ASC']];
-    }
-
-
-    /**
-     * manually_update_registration_statuses
-     *
-     * @param EE_Transaction $transaction
-     * @param string         $new_reg_status
-     * @param array          $registration_query_params array of query WHERE params to use
-     *                                                  when retrieving cached registrations from a transaction
-     * @return    boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function manually_update_registration_statuses(
-        EE_Transaction $transaction,
-        string $new_reg_status = '',
-        array $registration_query_params = []
-    ): bool {
-        $status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
-            'manually_update_registration_status',
-            $transaction,
-            $registration_query_params,
-            $new_reg_status
-        );
-        // send messages
-        /** @type EE_Registration_Processor $registration_processor */
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-        $registration_processor->trigger_registration_update_notifications(
-            $transaction->primary_registration(),
-            ['manually_updated' => true]
-        );
-        do_action(
-            'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
-            $transaction,
-            $status_updates
-        );
-        return $status_updates;
-    }
-
-
-    /**
-     * update_transaction_and_registrations_after_checkout_or_payment
-     * cycles thru related registrations and calls update_registration_after_checkout_or_payment() on each
-     *
-     * @param EE_Transaction  $transaction
-     * @param EE_Payment|null $payment
-     * @param array           $registration_query_params array of query WHERE params to use
-     *                                                   when retrieving cached registrations from a transaction
-     * @param bool            $trigger_notifications     whether to call EE_Registration_Processor::trigger_registration_update_notifications()
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_transaction_and_registrations_after_checkout_or_payment(
-        EE_Transaction $transaction,
-        ?EE_Payment $payment = null,
-        array $registration_query_params = [],
-        bool $trigger_notifications = true
-    ): array {
-        // make sure some query params are set for retrieving registrations
-        $this->_set_registration_query_params($registration_query_params);
-        // get final reg step status
-        $finalized = $transaction->final_reg_step_completed();
-        // if the 'finalize_registration' step has been initiated (has a timestamp)
-        // but has not yet been fully completed (TRUE)
-        if (is_int($finalized)) {
-            $transaction->set_reg_step_completed('finalize_registration');
-            $finalized = true;
-        }
-        $transaction->save();
-        // array of details to aid in decision-making by systems
-        $update_params = [
-            'old_txn_status'  => $transaction->old_txn_status(),
-            'new_txn_status'  => $transaction->status_ID(),
-            'finalized'       => $finalized,
-            'revisit'         => $this->_revisit,
-            'payment_updates' => $payment instanceof EE_Payment,
-            'last_payment'    => $payment,
-        ];
-        // now update the registrations and add the results to our $update_params
-        $update_params['status_updates'] = $this->_call_method_on_registrations_via_Registration_Processor(
-            'update_registration_after_checkout_or_payment',
-            $transaction,
-            $this->_registration_query_params,
-            $update_params
-        );
-        if ($trigger_notifications) {
-            // send messages
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            $registration_processor->trigger_registration_update_notifications(
-                $transaction->primary_registration(),
-                $update_params
-            );
-        }
-        do_action(
-            'AHEE__EE_Transaction_Processor__update_transaction_and_registrations_after_checkout_or_payment',
-            $transaction,
-            $update_params
-        );
-        return $update_params;
-    }
-
-
-    /**
-     * update_transaction_after_registration_reopened
-     * readjusts TXN and Line Item totals after a registration is changed from
-     * cancelled or declined to another reg status such as pending payment or approved
-     *
-     * @param EE_Registration $registration
-     * @param array           $closed_reg_statuses
-     * @param bool            $update_txn
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_transaction_after_reinstating_canceled_registration(
-        EE_Registration $registration,
-        array $closed_reg_statuses = [],
-        bool $update_txn = true
-    ): bool {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses)
-            ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
-            return false;
-        }
-        try {
-            $transaction      = $registration->transaction();
-            $ticket_line_item = $this->getTicketLineItemForRegistration($registration);
-            // un-cancel the ticket
-            $success = EEH_Line_Item::reinstate_canceled_ticket_line_item($ticket_line_item);
-        } catch (EE_Error $e) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The Ticket Line Item for Registration %1$d could not be reinstated because :%2$s%3$s',
-                        'event_espresso'
-                    ),
-                    $registration->ID(),
-                    '<br />',
-                    $e->getMessage()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if ($update_txn) {
-            return $transaction->save()
-                ? $success
-                : false;
-        }
-        return $success;
-    }
-
-
-    /**
-     * update_transaction_after_canceled_or_declined_registration
-     * readjusts TXN and Line Item totals after a registration is cancelled or declined
-     *
-     * @param EE_Registration $registration
-     * @param array           $closed_reg_statuses
-     * @param bool            $update_txn
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_transaction_after_canceled_or_declined_registration(
-        EE_Registration $registration,
-        array $closed_reg_statuses = [],
-        bool $update_txn = true
-    ): bool {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses)
-            ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
-            return false;
-        }
-        try {
-            $transaction = $registration->transaction();
-            if (
-                apply_filters(
-                    'FHEE__EE_Transaction_Processor__update_transaction_after_canceled_or_declined_registration__cancel_ticket_line_item',
-                    true,
-                    $registration,
-                    $transaction
-                )
-            ) {
-                $ticket_line_item = $this->getTicketLineItemForRegistration($registration);
-                EEH_Line_Item::cancel_ticket_line_item($ticket_line_item);
-            }
-        } catch (EE_Error $e) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The Ticket Line Item for Registration %1$d could not be cancelled because :%2$s%3$s',
-                        'event_espresso'
-                    ),
-                    $registration->ID(),
-                    '<br />',
-                    $e->getMessage()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return ! $update_txn || $transaction->save();
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getTicketLineItemForRegistration(EE_Registration $registration): EE_Line_Item
-    {
-        $ticket_line_item = EEM_Line_Item::instance()->get_ticket_line_item_for_transaction(
-            $registration->transaction_ID(),
-            $registration->ticket_ID()
-        );
-        if ($ticket_line_item instanceof EE_Line_Item) {
-            return $ticket_line_item;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    'The Line Item for Transaction %1$d and Ticket %2$d was not found or is invalid.',
-                    'event_espresso'
-                ),
-                $registration->transaction_ID(),
-                $registration->ticket_ID()
-            )
-        );
-    }
-
-
-    /**
-     * cancel_transaction_if_all_registrations_canceled
-     * cycles thru related registrations and checks their statuses
-     * if ALL registrations are Cancelled or Declined, then this sets the TXN status to
-     *
-     * @param EE_Transaction $transaction
-     * @param string         $new_TXN_status
-     * @param array          $registration_query_params    - array of query WHERE params to use when
-     *                                                     retrieving cached registrations from a transaction
-     * @param array          $closed_reg_statuses
-     * @param bool           $update_txn
-     * @return    bool            true if TXN status was updated, false if not
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function toggle_transaction_status_if_all_registrations_canceled_or_declined(
-        EE_Transaction $transaction,
-        string $new_TXN_status = '',
-        array $registration_query_params = [],
-        array $closed_reg_statuses = [],
-        bool $update_txn = true
-    ): bool {
-        // make sure some query params are set for retrieving registrations
-        $this->_set_registration_query_params($registration_query_params);
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses)
-            ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        // loop through cached registrations
-        foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
-            if (
-                $registration instanceof EE_Registration
-                && ! in_array($registration->status_ID(), $closed_reg_statuses)
-            ) {
-                return false;
-            }
-        }
-        if (in_array($new_TXN_status, EEM_Transaction::txn_status_array())) {
-            $transaction->set_status($new_TXN_status);
-        }
-        if ($update_txn) {
-            return (bool) $transaction->save();
-        }
-        return true;
-    }
-
-
-    /**
-     * _call_method_on_registrations_via_Registration_Processor
-     * cycles thru related registrations and calls the requested method on each
-     *
-     * @param string            $method_name
-     * @param EE_Transaction    $transaction
-     * @param array             $registration_query_params array of query WHERE params to use
-     *                                                     when retrieving cached registrations from a transaction
-     * @param array|string|null $additional_param
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _call_method_on_registrations_via_Registration_Processor(
-        string $method_name,
-        EE_Transaction $transaction,
-        array $registration_query_params = [],
-        $additional_param = null
-    ): bool {
-        $response = false;
-        /** @type EE_Registration_Processor $registration_processor */
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-        // check that method exists
-        if (! method_exists($registration_processor, $method_name)) {
-            throw new EE_Error(esc_html__('Method does not exist.', 'event_espresso'));
-        }
-        // make sure some query params are set for retrieving registrations
-        $this->_set_registration_query_params($registration_query_params);
-        // loop through cached registrations
-        foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
-            if ($registration instanceof EE_Registration) {
-                if ($additional_param) {
-                    $response = $registration_processor->{$method_name}($registration, $additional_param)
-                        ? true
-                        : $response;
-                } else {
-                    $response = $registration_processor->{$method_name}($registration)
-                        ? true
-                        : $response;
-                }
-            }
-        }
-        return (bool) $response;
-    }
-
-
-    /**
-     * set_transaction_payment_method_based_on_registration_statuses
-     * sets or unsets the PMD_ID field on the TXN based on the related REG statuses
-     * basically if ALL Registrations are "Not Approved", then the EE_Transaction.PMD_ID is set to null,
-     * but if any Registration has a different status, then EE_Transaction.PMD_ID is set to either:
-     *        the first "default" Payment Method
-     *        the first active Payment Method
-     *    whichever is found first.
-     *
-     * @param EE_Registration $edited_registration
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_transaction_payment_method_based_on_registration_statuses(
-        EE_Registration $edited_registration
-    ) {
-        $transaction      = $edited_registration->transaction();
-        $all_not_approved = true;
-        foreach ($transaction->registrations() as $registration) {
-            if ($registration instanceof EE_Registration) {
-                // if any REG != "Not Approved" then toggle to false
-                $all_not_approved = $registration->is_not_approved()
-                    ? $all_not_approved
-                    : false;
-            }
-        }
-        // if ALL Registrations are "Not Approved"
-        if ($all_not_approved) {
-            $transaction->set_payment_method_ID(0);
-            $transaction->save();
-        } else {
-            $available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
-                $transaction,
-                EEM_Payment_Method::scope_cart
-            );
-            if (! empty($available_payment_methods)) {
-                $PMD_ID = 0;
-                foreach ($available_payment_methods as $available_payment_method) {
-                    if (
-                        $available_payment_method instanceof EE_Payment_Method
-                        && $available_payment_method->open_by_default()
-                    ) {
-                        $PMD_ID = $available_payment_method->ID();
-                        break;
-                    }
-                }
-                if (! $PMD_ID) {
-                    $first_payment_method = reset($available_payment_methods);
-                    if ($first_payment_method instanceof EE_Payment_Method) {
-                        $PMD_ID = $first_payment_method->ID();
-                    } else {
-                        EE_Error::add_error(
-                            esc_html__(
-                                'A valid Payment Method could not be determined. Please ensure that at least one Payment Method is activated.',
-                                'event_espresso'
-                            ),
-                            __FILE__,
-                            __LINE__,
-                            __FUNCTION__
-                        );
-                    }
-                }
-                $transaction->set_payment_method_ID($PMD_ID);
-                $transaction->save();
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'Please activate at least one Payment Method in order for things to operate correctly.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __LINE__,
-                    __FUNCTION__
-                );
-            }
-        }
-    }
-
-
-
-    /********************************** DEPRECATED METHODS **********************************/
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return EE_Transaction
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @depecated 5.0.25.p
-     */
-    public function get_transaction_for_registration(EE_Registration $registration): EE_Transaction
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic is no longer necessary. Please just call EE_Registration::transaction() instead.',
-                'event_espresso'
-            ),
-            '5.0.25.p',
-            '6.0.0'
-        );
-        return $registration->transaction();
-    }
-
-
-    /**
-     * @param EE_Transaction  $transaction
-     * @param EE_Registration $registration
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @depecated 5.0.25.p
-     */
-    public function get_ticket_line_item_for_transaction_registration(
-        EE_Transaction $transaction,
-        EE_Registration $registration
-    ): EE_Line_Item {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic been replaced by EE_Transaction_Processor::getTicketLineItemForRegistration(). Please use that method instead.',
-                'event_espresso'
-            ),
-            '5.0.25.p',
-            '6.0.0'
-        );
-        return $this->getTicketLineItemForRegistration($registration);
-    }
-
-
-    /**
-     * toggle_registration_statuses_for_default_approved_events
-     *
-     * @param EE_Transaction $transaction
-     * @param array          $registration_query_params array of query WHERE params to use
-     *                                                  when retrieving cached registrations from a transaction
-     * @return    boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @depecated 5.0.25.p
-     */
-    public function toggle_registration_statuses_for_default_approved_events(
-        EE_Transaction $transaction,
-        array $registration_query_params = []
-    ): bool {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic been replaced by EE_Registration_Processor::toggle_registration_status_for_default_approved_events(). Please use that method instead.',
-                'event_espresso'
-            ),
-            '5.0.25.p',
-            '6.0.0'
-        );
-        $status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
-            'toggle_registration_status_for_default_approved_events',
-            $transaction,
-            $registration_query_params
-        );
-        do_action(
-            'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
-            $transaction,
-            $status_updates
-        );
-        return $status_updates;
-    }
-
-
-    /**
-     * toggle_registration_statuses_if_no_monies_owing
-     *
-     * @param EE_Transaction $transaction
-     * @param array          $registration_query_params array of query WHERE params to use
-     *                                                  when retrieving cached registrations from a transaction
-     * @return    boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @depecated 5.0.25.p
-     */
-    public function toggle_registration_statuses_if_no_monies_owing(
-        EE_Transaction $transaction,
-        array $registration_query_params = []
-    ): bool {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic been replaced by EE_Registration_Processor::toggle_registration_status_if_no_monies_owing(). Please use that method instead.',
-                'event_espresso'
-            ),
-            '5.0.25.p',
-            '6.0.0'
-        );
-        $status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
-            'toggle_registration_status_if_no_monies_owing',
-            $transaction,
-            $registration_query_params
-        );
-        do_action(
-            'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing',
-            $transaction,
-            $status_updates
-        );
-        return $status_updates;
-    }
+	private static ?EE_Transaction_Processor $_instance = null;
+
+	/**
+	 * array of query WHERE params to use when retrieving cached registrations from a transaction
+	 *
+	 * @var array $registration_query_params
+	 */
+	private array $_registration_query_params = [];
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param array $registration_query_params
+	 * @return EE_Transaction_Processor instance
+	 */
+	public static function instance(array $registration_query_params = []): EE_Transaction_Processor
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Transaction_Processor) {
+			self::$_instance = new self($registration_query_params);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @param array $registration_query_params
+	 */
+	private function __construct(array $registration_query_params = [])
+	{
+		// make sure some query params are set for retrieving registrations
+		$this->_set_registration_query_params($registration_query_params);
+	}
+
+
+	/**
+	 * @param array $registration_query_params
+	 */
+	private function _set_registration_query_params(array $registration_query_params)
+	{
+		$this->_registration_query_params = ! empty($registration_query_params)
+			? $registration_query_params
+			: ['order_by' => ['REG_count' => 'ASC']];
+	}
+
+
+	/**
+	 * manually_update_registration_statuses
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param string         $new_reg_status
+	 * @param array          $registration_query_params array of query WHERE params to use
+	 *                                                  when retrieving cached registrations from a transaction
+	 * @return    boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function manually_update_registration_statuses(
+		EE_Transaction $transaction,
+		string $new_reg_status = '',
+		array $registration_query_params = []
+	): bool {
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
+			'manually_update_registration_status',
+			$transaction,
+			$registration_query_params,
+			$new_reg_status
+		);
+		// send messages
+		/** @type EE_Registration_Processor $registration_processor */
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+		$registration_processor->trigger_registration_update_notifications(
+			$transaction->primary_registration(),
+			['manually_updated' => true]
+		);
+		do_action(
+			'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
+			$transaction,
+			$status_updates
+		);
+		return $status_updates;
+	}
+
+
+	/**
+	 * update_transaction_and_registrations_after_checkout_or_payment
+	 * cycles thru related registrations and calls update_registration_after_checkout_or_payment() on each
+	 *
+	 * @param EE_Transaction  $transaction
+	 * @param EE_Payment|null $payment
+	 * @param array           $registration_query_params array of query WHERE params to use
+	 *                                                   when retrieving cached registrations from a transaction
+	 * @param bool            $trigger_notifications     whether to call EE_Registration_Processor::trigger_registration_update_notifications()
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_transaction_and_registrations_after_checkout_or_payment(
+		EE_Transaction $transaction,
+		?EE_Payment $payment = null,
+		array $registration_query_params = [],
+		bool $trigger_notifications = true
+	): array {
+		// make sure some query params are set for retrieving registrations
+		$this->_set_registration_query_params($registration_query_params);
+		// get final reg step status
+		$finalized = $transaction->final_reg_step_completed();
+		// if the 'finalize_registration' step has been initiated (has a timestamp)
+		// but has not yet been fully completed (TRUE)
+		if (is_int($finalized)) {
+			$transaction->set_reg_step_completed('finalize_registration');
+			$finalized = true;
+		}
+		$transaction->save();
+		// array of details to aid in decision-making by systems
+		$update_params = [
+			'old_txn_status'  => $transaction->old_txn_status(),
+			'new_txn_status'  => $transaction->status_ID(),
+			'finalized'       => $finalized,
+			'revisit'         => $this->_revisit,
+			'payment_updates' => $payment instanceof EE_Payment,
+			'last_payment'    => $payment,
+		];
+		// now update the registrations and add the results to our $update_params
+		$update_params['status_updates'] = $this->_call_method_on_registrations_via_Registration_Processor(
+			'update_registration_after_checkout_or_payment',
+			$transaction,
+			$this->_registration_query_params,
+			$update_params
+		);
+		if ($trigger_notifications) {
+			// send messages
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			$registration_processor->trigger_registration_update_notifications(
+				$transaction->primary_registration(),
+				$update_params
+			);
+		}
+		do_action(
+			'AHEE__EE_Transaction_Processor__update_transaction_and_registrations_after_checkout_or_payment',
+			$transaction,
+			$update_params
+		);
+		return $update_params;
+	}
+
+
+	/**
+	 * update_transaction_after_registration_reopened
+	 * readjusts TXN and Line Item totals after a registration is changed from
+	 * cancelled or declined to another reg status such as pending payment or approved
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $closed_reg_statuses
+	 * @param bool            $update_txn
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_transaction_after_reinstating_canceled_registration(
+		EE_Registration $registration,
+		array $closed_reg_statuses = [],
+		bool $update_txn = true
+	): bool {
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses)
+			? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+			return false;
+		}
+		try {
+			$transaction      = $registration->transaction();
+			$ticket_line_item = $this->getTicketLineItemForRegistration($registration);
+			// un-cancel the ticket
+			$success = EEH_Line_Item::reinstate_canceled_ticket_line_item($ticket_line_item);
+		} catch (EE_Error $e) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The Ticket Line Item for Registration %1$d could not be reinstated because :%2$s%3$s',
+						'event_espresso'
+					),
+					$registration->ID(),
+					'<br />',
+					$e->getMessage()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if ($update_txn) {
+			return $transaction->save()
+				? $success
+				: false;
+		}
+		return $success;
+	}
+
+
+	/**
+	 * update_transaction_after_canceled_or_declined_registration
+	 * readjusts TXN and Line Item totals after a registration is cancelled or declined
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $closed_reg_statuses
+	 * @param bool            $update_txn
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_transaction_after_canceled_or_declined_registration(
+		EE_Registration $registration,
+		array $closed_reg_statuses = [],
+		bool $update_txn = true
+	): bool {
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses)
+			? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+			return false;
+		}
+		try {
+			$transaction = $registration->transaction();
+			if (
+				apply_filters(
+					'FHEE__EE_Transaction_Processor__update_transaction_after_canceled_or_declined_registration__cancel_ticket_line_item',
+					true,
+					$registration,
+					$transaction
+				)
+			) {
+				$ticket_line_item = $this->getTicketLineItemForRegistration($registration);
+				EEH_Line_Item::cancel_ticket_line_item($ticket_line_item);
+			}
+		} catch (EE_Error $e) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The Ticket Line Item for Registration %1$d could not be cancelled because :%2$s%3$s',
+						'event_espresso'
+					),
+					$registration->ID(),
+					'<br />',
+					$e->getMessage()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return ! $update_txn || $transaction->save();
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getTicketLineItemForRegistration(EE_Registration $registration): EE_Line_Item
+	{
+		$ticket_line_item = EEM_Line_Item::instance()->get_ticket_line_item_for_transaction(
+			$registration->transaction_ID(),
+			$registration->ticket_ID()
+		);
+		if ($ticket_line_item instanceof EE_Line_Item) {
+			return $ticket_line_item;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'The Line Item for Transaction %1$d and Ticket %2$d was not found or is invalid.',
+					'event_espresso'
+				),
+				$registration->transaction_ID(),
+				$registration->ticket_ID()
+			)
+		);
+	}
+
+
+	/**
+	 * cancel_transaction_if_all_registrations_canceled
+	 * cycles thru related registrations and checks their statuses
+	 * if ALL registrations are Cancelled or Declined, then this sets the TXN status to
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param string         $new_TXN_status
+	 * @param array          $registration_query_params    - array of query WHERE params to use when
+	 *                                                     retrieving cached registrations from a transaction
+	 * @param array          $closed_reg_statuses
+	 * @param bool           $update_txn
+	 * @return    bool            true if TXN status was updated, false if not
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function toggle_transaction_status_if_all_registrations_canceled_or_declined(
+		EE_Transaction $transaction,
+		string $new_TXN_status = '',
+		array $registration_query_params = [],
+		array $closed_reg_statuses = [],
+		bool $update_txn = true
+	): bool {
+		// make sure some query params are set for retrieving registrations
+		$this->_set_registration_query_params($registration_query_params);
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses)
+			? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		// loop through cached registrations
+		foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
+			if (
+				$registration instanceof EE_Registration
+				&& ! in_array($registration->status_ID(), $closed_reg_statuses)
+			) {
+				return false;
+			}
+		}
+		if (in_array($new_TXN_status, EEM_Transaction::txn_status_array())) {
+			$transaction->set_status($new_TXN_status);
+		}
+		if ($update_txn) {
+			return (bool) $transaction->save();
+		}
+		return true;
+	}
+
+
+	/**
+	 * _call_method_on_registrations_via_Registration_Processor
+	 * cycles thru related registrations and calls the requested method on each
+	 *
+	 * @param string            $method_name
+	 * @param EE_Transaction    $transaction
+	 * @param array             $registration_query_params array of query WHERE params to use
+	 *                                                     when retrieving cached registrations from a transaction
+	 * @param array|string|null $additional_param
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _call_method_on_registrations_via_Registration_Processor(
+		string $method_name,
+		EE_Transaction $transaction,
+		array $registration_query_params = [],
+		$additional_param = null
+	): bool {
+		$response = false;
+		/** @type EE_Registration_Processor $registration_processor */
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+		// check that method exists
+		if (! method_exists($registration_processor, $method_name)) {
+			throw new EE_Error(esc_html__('Method does not exist.', 'event_espresso'));
+		}
+		// make sure some query params are set for retrieving registrations
+		$this->_set_registration_query_params($registration_query_params);
+		// loop through cached registrations
+		foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
+			if ($registration instanceof EE_Registration) {
+				if ($additional_param) {
+					$response = $registration_processor->{$method_name}($registration, $additional_param)
+						? true
+						: $response;
+				} else {
+					$response = $registration_processor->{$method_name}($registration)
+						? true
+						: $response;
+				}
+			}
+		}
+		return (bool) $response;
+	}
+
+
+	/**
+	 * set_transaction_payment_method_based_on_registration_statuses
+	 * sets or unsets the PMD_ID field on the TXN based on the related REG statuses
+	 * basically if ALL Registrations are "Not Approved", then the EE_Transaction.PMD_ID is set to null,
+	 * but if any Registration has a different status, then EE_Transaction.PMD_ID is set to either:
+	 *        the first "default" Payment Method
+	 *        the first active Payment Method
+	 *    whichever is found first.
+	 *
+	 * @param EE_Registration $edited_registration
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_transaction_payment_method_based_on_registration_statuses(
+		EE_Registration $edited_registration
+	) {
+		$transaction      = $edited_registration->transaction();
+		$all_not_approved = true;
+		foreach ($transaction->registrations() as $registration) {
+			if ($registration instanceof EE_Registration) {
+				// if any REG != "Not Approved" then toggle to false
+				$all_not_approved = $registration->is_not_approved()
+					? $all_not_approved
+					: false;
+			}
+		}
+		// if ALL Registrations are "Not Approved"
+		if ($all_not_approved) {
+			$transaction->set_payment_method_ID(0);
+			$transaction->save();
+		} else {
+			$available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
+				$transaction,
+				EEM_Payment_Method::scope_cart
+			);
+			if (! empty($available_payment_methods)) {
+				$PMD_ID = 0;
+				foreach ($available_payment_methods as $available_payment_method) {
+					if (
+						$available_payment_method instanceof EE_Payment_Method
+						&& $available_payment_method->open_by_default()
+					) {
+						$PMD_ID = $available_payment_method->ID();
+						break;
+					}
+				}
+				if (! $PMD_ID) {
+					$first_payment_method = reset($available_payment_methods);
+					if ($first_payment_method instanceof EE_Payment_Method) {
+						$PMD_ID = $first_payment_method->ID();
+					} else {
+						EE_Error::add_error(
+							esc_html__(
+								'A valid Payment Method could not be determined. Please ensure that at least one Payment Method is activated.',
+								'event_espresso'
+							),
+							__FILE__,
+							__LINE__,
+							__FUNCTION__
+						);
+					}
+				}
+				$transaction->set_payment_method_ID($PMD_ID);
+				$transaction->save();
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'Please activate at least one Payment Method in order for things to operate correctly.',
+						'event_espresso'
+					),
+					__FILE__,
+					__LINE__,
+					__FUNCTION__
+				);
+			}
+		}
+	}
+
+
+
+	/********************************** DEPRECATED METHODS **********************************/
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @depecated 5.0.25.p
+	 */
+	public function get_transaction_for_registration(EE_Registration $registration): EE_Transaction
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic is no longer necessary. Please just call EE_Registration::transaction() instead.',
+				'event_espresso'
+			),
+			'5.0.25.p',
+			'6.0.0'
+		);
+		return $registration->transaction();
+	}
+
+
+	/**
+	 * @param EE_Transaction  $transaction
+	 * @param EE_Registration $registration
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @depecated 5.0.25.p
+	 */
+	public function get_ticket_line_item_for_transaction_registration(
+		EE_Transaction $transaction,
+		EE_Registration $registration
+	): EE_Line_Item {
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic been replaced by EE_Transaction_Processor::getTicketLineItemForRegistration(). Please use that method instead.',
+				'event_espresso'
+			),
+			'5.0.25.p',
+			'6.0.0'
+		);
+		return $this->getTicketLineItemForRegistration($registration);
+	}
+
+
+	/**
+	 * toggle_registration_statuses_for_default_approved_events
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param array          $registration_query_params array of query WHERE params to use
+	 *                                                  when retrieving cached registrations from a transaction
+	 * @return    boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @depecated 5.0.25.p
+	 */
+	public function toggle_registration_statuses_for_default_approved_events(
+		EE_Transaction $transaction,
+		array $registration_query_params = []
+	): bool {
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic been replaced by EE_Registration_Processor::toggle_registration_status_for_default_approved_events(). Please use that method instead.',
+				'event_espresso'
+			),
+			'5.0.25.p',
+			'6.0.0'
+		);
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
+			'toggle_registration_status_for_default_approved_events',
+			$transaction,
+			$registration_query_params
+		);
+		do_action(
+			'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
+			$transaction,
+			$status_updates
+		);
+		return $status_updates;
+	}
+
+
+	/**
+	 * toggle_registration_statuses_if_no_monies_owing
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param array          $registration_query_params array of query WHERE params to use
+	 *                                                  when retrieving cached registrations from a transaction
+	 * @return    boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @depecated 5.0.25.p
+	 */
+	public function toggle_registration_statuses_if_no_monies_owing(
+		EE_Transaction $transaction,
+		array $registration_query_params = []
+	): bool {
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic been replaced by EE_Registration_Processor::toggle_registration_status_if_no_monies_owing(). Please use that method instead.',
+				'event_espresso'
+			),
+			'5.0.25.p',
+			'6.0.0'
+		);
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
+			'toggle_registration_status_if_no_monies_owing',
+			$transaction,
+			$registration_query_params
+		);
+		do_action(
+			'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing',
+			$transaction,
+			$status_updates
+		);
+		return $status_updates;
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-require_once __DIR__ . '/EE_Processor_Base.class.php';
+require_once __DIR__.'/EE_Processor_Base.class.php';
 
 /**
  * Class EE_Transaction_Processor
@@ -34,7 +34,7 @@ 
     public static function instance(array $registration_query_params = []): EE_Transaction_Processor
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Transaction_Processor) {
+        if ( ! self::$_instance instanceof EE_Transaction_Processor) {
             self::$_instance = new self($registration_query_params);
         }
         return self::$_instance;
@@ -239,7 +239,7 @@ 
         $closed_reg_statuses = ! empty($closed_reg_statuses)
             ? $closed_reg_statuses
             : EEM_Registration::closed_reg_statuses();
-        if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+        if ( ! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
             return false;
         }
         try {
@@ -374,7 +374,7 @@ 
         /** @type EE_Registration_Processor $registration_processor */
         $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
         // check that method exists
-        if (! method_exists($registration_processor, $method_name)) {
+        if ( ! method_exists($registration_processor, $method_name)) {
             throw new EE_Error(esc_html__('Method does not exist.', 'event_espresso'));
         }
         // make sure some query params are set for retrieving registrations
@@ -433,7 +433,7 @@ 
                 $transaction,
                 EEM_Payment_Method::scope_cart
             );
-            if (! empty($available_payment_methods)) {
+            if ( ! empty($available_payment_methods)) {
                 $PMD_ID = 0;
                 foreach ($available_payment_methods as $available_payment_method) {
                     if (
@@ -444,7 +444,7 @@ 
                         break;
                     }
                 }
-                if (! $PMD_ID) {
+                if ( ! $PMD_ID) {
                     $first_payment_method = reset($available_payment_methods);
                     if ($first_payment_method instanceof EE_Payment_Method) {
                         $PMD_ID = $first_payment_method->ID();

core/business/EE_Processor_Base.class.php

Indentation +59 added lines, -59 removed lines

@@ -10,71 +10,71 @@
  */
 class EE_Processor_Base
 {
-    /**
-     * Used to indicate whether current request is for an IPN or not.
-     *
-     * @var bool
-     */
-    protected static bool $IPN = false;
+	/**
+	 * Used to indicate whether current request is for an IPN or not.
+	 *
+	 * @var bool
+	 */
+	protected static bool $IPN = false;
 
-    /**
-     * Used to indicate whether SPCO is being revisited by registrant or not.
-     *
-     * @var bool
-     */
-    protected bool $_revisit = false;
+	/**
+	 * Used to indicate whether SPCO is being revisited by registrant or not.
+	 *
+	 * @var bool
+	 */
+	protected bool $_revisit = false;
 
-    private static bool $debug = false;
+	private static bool $debug = false;
 
 
-    /**
-     * @param bool|int|string $IPN truthy/falsey value
-     */
-    public static function set_IPN($IPN)
-    {
-        self::$IPN = filter_var($IPN, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * @param bool|int|string $IPN truthy/falsey value
+	 */
+	public static function set_IPN($IPN)
+	{
+		self::$IPN = filter_var($IPN, FILTER_VALIDATE_BOOLEAN);
+	}
 
 
-    /**
-     * Allows external class (usually checkout) to set whether SPCO is being revisited by registrant or not.
-     *
-     * @param bool|int|string $revisit
-     * @return void
-     */
-    public function set_revisit($revisit = false)
-    {
-        $this->_revisit = filter_var($revisit, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * Allows external class (usually checkout) to set whether SPCO is being revisited by registrant or not.
+	 *
+	 * @param bool|int|string $revisit
+	 * @return void
+	 */
+	public function set_revisit($revisit = false)
+	{
+		$this->_revisit = filter_var($revisit, FILTER_VALIDATE_BOOLEAN);
+	}
 
 
-    /**
-     * debug
-     *
-     * @param string              $class
-     * @param string              $func
-     * @param int|string          $line
-     * @param EE_Transaction|null $transaction
-     * @param array               $info
-     * @param bool                $display_request
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function log(
-        string $class = '',
-        string $func = '',
-        $line = '',
-        ?EE_Transaction $transaction = null,
-        array $info = [],
-        bool $display_request = false
-    ) {
-        if (EE_Processor_Base::$debug && $transaction instanceof EE_Transaction && $transaction->ID()) {
-            // don't serialize objects
-            $info = EEH_Debug_Tools::strip_objects($info);
-            $info['TXN_status']    = $transaction->status_ID();
-            $info['TXN_reg_steps'] = $transaction->reg_steps();
-            $index                 = 'EE_Transaction: ' . $transaction->ID();
-            EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
-        }
-    }
+	/**
+	 * debug
+	 *
+	 * @param string              $class
+	 * @param string              $func
+	 * @param int|string          $line
+	 * @param EE_Transaction|null $transaction
+	 * @param array               $info
+	 * @param bool                $display_request
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function log(
+		string $class = '',
+		string $func = '',
+		$line = '',
+		?EE_Transaction $transaction = null,
+		array $info = [],
+		bool $display_request = false
+	) {
+		if (EE_Processor_Base::$debug && $transaction instanceof EE_Transaction && $transaction->ID()) {
+			// don't serialize objects
+			$info = EEH_Debug_Tools::strip_objects($info);
+			$info['TXN_status']    = $transaction->status_ID();
+			$info['TXN_reg_steps'] = $transaction->reg_steps();
+			$index                 = 'EE_Transaction: ' . $transaction->ID();
+			EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -73,7 +73,7 @@
             $info = EEH_Debug_Tools::strip_objects($info);
             $info['TXN_status']    = $transaction->status_ID();
             $info['TXN_reg_steps'] = $transaction->reg_steps();
-            $index                 = 'EE_Transaction: ' . $transaction->ID();
+            $index                 = 'EE_Transaction: '.$transaction->ID();
             EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
         }
     }