Payments::configureSuccessRedirectRoute() - Code Metrics - getparthenon/parthenon - Measure and Improve Code Quality continuously with Scrutinizer

Payments::configureSuccessRedirectRoute() A
last analyzed 2025-01-23 10:56 UTC

↳ Parent: Payments
Complexity

Conditions	4
Paths	4
Size

Total Lines	10
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	4
eloc	7
c	1
b	0
f	0
nc	4
nop	2
dl	0
loc	10
rs	10
<?php

declare(strict_types=1);

/*
 * Copyright (C) 2020-2025 Iain Cambridge
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU LESSER GENERAL PUBLIC LICENSE as published by
 * the Free Software Foundation, either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

namespace Parthenon\DependencyInjection\Modules;

use Parthenon\Common\Exception\ParameterNotSetException;
use Parthenon\Payments\Athena\TeamSubscriberSection;
use Parthenon\Payments\Athena\UserSubscriberSection;
use Parthenon\Payments\PaymentProvider\TransactionCloud\Config;
use Parthenon\Payments\Plan\CounterInterface;
use Parthenon\Payments\Repository\SubscriberRepositoryInterface;
use Parthenon\Payments\Subscriber\SubscriberInterface;
use Parthenon\Payments\Transition\ToActiveTransitionInterface;
use Parthenon\Payments\Transition\ToCancelledTransitionInterface;
use Parthenon\Payments\Transition\ToOverdueTransitionInterface;
use Parthenon\User\Repository\TeamRepositoryInterface;
use Parthenon\User\Repository\UserRepositoryInterface;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\NodeBuilder;
use Symfony\Component\Config\Definition\Builder\NodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;

final class Payments implements ModuleConfigurationInterface
{
    public function addConfig(NodeBuilder $nodeBuilder): void
    {
        $nodeBuilder
            ->arrayNode('payments')
                ->children()
                    ->booleanNode('enabled')->end()
                    ->scalarNode('provider')->end()
                    ->/** @scrutinizer ignore-call */ scalarNode('provider')->end()
                    ->scalarNode('success_redirect_route')->end()
                    ->scalarNode('cancel_checkout_redirect_route')->end()
                    ->arrayNode('stripe')
                        ->children()
                            ->scalarNode('private_api_key')->end()
                            ->scalarNode('public_api_key')->end()
                            ->scalarNode('success_url')->end()
                            ->scalarNode('cancel_url')->end()
                            ->scalarNode('return_url')->end()
                        ->end()
                    ->end()
                    ->arrayNode('transaction_cloud')
                        ->children()
                            ->scalarNode('api_key')->end()
                            ->scalarNode('api_key_password')->end()
                            ->booleanNode('sandbox')->defaultFalse()->end()
                            ->scalarNode('customer_id_parameter')->end()
                            ->scalarNode('payment_id_parameter')->end()
                        ->end()
                    ->end()
                    ->arrayNode('subscriptions')
                    ->children()
                        ->scalarNode('subscriber_type')->end()
                    ->end()
                    ->fixXmlConfig('plans')
                    ->append($this->getPlansNode())
                    ->end()
                ->end()
                ->fixXmlConfig('prices')
                ->append($this->getPricesNode())

            ->end();
    }

    public function handleDefaultParameters(ContainerBuilder $container): void
    {
        $container->setParameter('parthenon_payments_subscriber_type', '');

        $container->setParameter('parthenon_payments_stripe_private_api_key', '');
        $container->setParameter('parthenon_payments_stripe_public_api_key', '');
        $container->setParameter('parthenon_payments_stripe_success_url', '');
        $container->setParameter('parthenon_payments_stripe_cancel_url', '');
        $container->setParameter('parthenon_payments_stripe_return_url', '');

        $container->setParameter('parthenon_payments_transaction_cloud_api_key', '');
        $container->setParameter('parthenon_payments_transaction_cloud_api_key_password', '');
        $container->setParameter('parthenon_payments_transaction_cloud_sandbox', false);
        $container->setParameter('parthenon_payments_transaction_cloud_customer_id_parameter', Config::DEFAULT_CUSTOMER_ID_PARAMETER);
        $container->setParameter('parthenon_payments_transaction_cloud_payment_id_parameter', Config::DEFAULT_PAYMENT_ID_PARAMETER);

        $container->setParameter('parthenon_payments_prices', []);
        $container->setParameter('parthenon_payments_plan_plans', []);
        $container->setParameter('parthenon_payments_success_redirect_route', 'app_index');
        $container->setParameter('parthenon_payments_cancel_checkout_redirect_route', null);
    }

    public function handleConfiguration(array $config, ContainerBuilder $container): void
    {
        if (!isset($config['payments']) || !isset($config['payments']['enabled']) || false == $config['payments']['enabled']) {
            return;
        }
        $container->setParameter('parthenon_payments_enabled', true);
        $container->setParameter('parthenon_payments_plan_plans', $config['payments']['subscriptions']['plan']);
        $container->registerForAutoconfiguration(CounterInterface::class)->addTag('parthenon.payments.plan.counter');
        $container->registerForAutoconfiguration(ToActiveTransitionInterface::class)->addTag('parthenon.payments.transitions.to_active');
        $container->registerForAutoconfiguration(ToCancelledTransitionInterface::class)->addTag('parthenon.payments.transitions.to_cancelled');
        $container->registerForAutoconfiguration(ToOverdueTransitionInterface::class)->addTag('parthenon.payments.transitions.to_overdue');

        $this->configureSubscriberType($config, $container);

        $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../../Resources/config'));

        if ('stripe' === strtolower($config['payments']['provider'])) {
            $this->handlePaymentsStripe($config, $container);
            $loader->load('services/payments/stripe.xml');
        } elseif ('transaction_cloud' === strtolower($config['payments']['provider'])) {
            $this->handlePaymentsTransactionCloud($config, $container);
            $loader->load('services/payments/transaction_cloud.xml');
        }
        $config = $this->configurePrice($config, $container);


        $loader->load('services/payments.xml');
    }

    private function handlePaymentsTransactionCloud(array $config, ContainerBuilder $containerBuilder)
    {
        if (empty($config['payments']['transaction_cloud'])) {
            throw new ParameterNotSetException('Then payment.provider is transaction_cloud then payments.transaction_cloud must be provided');
        }

        $transactionCloudConfig = $config['payments']['transaction_cloud'];

        if (!isset($transactionCloudConfig['api_key'])) {
            throw new ParameterNotSetException('Then payment.provider is transaction_cloud then payments.transaction_cloud.api_key must be provided');
        }
        if (!isset($transactionCloudConfig['api_key_password'])) {
            throw new ParameterNotSetException('Then payment.provider is transaction_cloud then payments.transaction_cloud.api_key must be provided');
        }

        $containerBuilder->setParameter('parthenon_payments_transaction_cloud_api_key', $transactionCloudConfig['api_key']);
        $containerBuilder->setParameter('parthenon_payments_transaction_cloud_api_key_password', $transactionCloudConfig['api_key_password']);
        $containerBuilder->setParameter('parthenon_payments_transaction_cloud_sandbox', $transactionCloudConfig['sandbox'] ?? false);
        $containerBuilder->setParameter('parthenon_payments_transaction_cloud_customer_id_parameter', $transactionCloudConfig['customer_id_parameter'] ?? Config::DEFAULT_CUSTOMER_ID_PARAMETER);
        $containerBuilder->setParameter('parthenon_payments_transaction_cloud_payment_id_parameter', $transactionCloudConfig['payment_id_parameter'] ?? Config::DEFAULT_PAYMENT_ID_PARAMETER);
    }

    private function handlePaymentsStripe(array $config, ContainerBuilder $containerBuilder)
    {
        if (empty($config['payments']['stripe'])) {
            throw new ParameterNotSetException('When payment.provider is stripe then payments.stripe needs to be provided');
        }

        $stripeConfig = $config['payments']['stripe'];
        $stripeConfig = $this->configureStripePrivateApiKey($stripeConfig);
        $stripeConfig = $this->configureStripePublicKey($stripeConfig);
        $stripeConfig = $this->configureStripeSuccessUrl($stripeConfig);
        $stripeConfig = $this->configureCancelUrl($stripeConfig);

        $containerBuilder->setParameter('parthenon_payments_stripe_private_api_key', $stripeConfig['private_api_key'] ?? '');
        $containerBuilder->setParameter('parthenon_payments_stripe_public_api_key', $stripeConfig['public_api_key'] ?? '');
        $containerBuilder->setParameter('parthenon_payments_stripe_success_url', $stripeConfig['success_url'] ?? '');
        $containerBuilder->setParameter('parthenon_payments_stripe_cancel_url', $stripeConfig['cancel_url'] ?? '');
        $containerBuilder->setParameter('parthenon_payments_stripe_return_url', $stripeConfig['return_url'] ?? '');

        $this->configureSuccessRedirectRoute($config, $containerBuilder);
    }

    private function getPricesNode(): NodeDefinition
    {
        $treeBuilder = new TreeBuilder('price');
        $node = $treeBuilder->getRootNode();

        /** @var ArrayNodeDefinition $planNode */
        $planNode = $node
            ->requiresAtLeastOneElement()
            ->/** @scrutinizer ignore-call */ requiresAtLeastOneElement()
            ->useAttributeAsKey('name')
            ->prototype('array');

        $planNode
            ->fixXmlConfig('prices')
                    ->requiresAtLeastOneElement()
                        ->useAttributeAsKey('paymentSchedule')
                        ->prototype('array')
                            ->children()
                                ->scalarNode('price')->end()
                                ->scalarNode('price_id')->end()
                                ->booleanNode('subscription')->end()
                                ->scalarNode('trial_day_length')->end()
                            ->end()
                        ->end()
                    ->end()
            ->end();

        return $node;
    }

    private function configureSuccessRedirectRoute(array $config, ContainerBuilder $containerBuilder): void
    {
        if (isset($config['payments']['success_redirect_route'])) {
            $containerBuilder->setParameter('parthenon_payments_success_redirect_route', $config['payments']['success_redirect_route']);
        }
        if (isset($config['payments']['cancel_checkout_redirect_route']) && !empty($config['payments']['cancel_checkout_redirect_route'])) {
            $containerBuilder->setParameter('parthenon_payments_cancel_checkout_redirect_route', $config['payments']['cancel_checkout_redirect_route']);
        } else {
            $defaultRoute = $containerBuilder->getParameter('parthenon_payments_success_redirect_route');
            $containerBuilder->setParameter('parthenon_payments_cancel_checkout_redirect_route', $defaultRoute);
        }
    }

    private function configurePrice(array $config, ContainerBuilder $containerBuilder): array
    {
        if (isset($config['payments']['price'])) {
            $containerBuilder->setParameter('parthenon_payments_prices', $config['payments']['price']);
        }

        return $config;
    }

    /**
     * @throws ParameterNotSetException
     */
    private function configureStripePrivateApiKey(mixed $stripeConfig): mixed
    {
        if (!isset($stripeConfig['private_api_key'])) {
            throw new ParameterNotSetException('When payment.provide is stripe then payments.stripe.private_api_key needs to be provided');
        }

        return $stripeConfig;
    }

    /**
     * @throws ParameterNotSetException
     */
    private function configureStripePublicKey(mixed $stripeConfig): mixed
    {
        if (!isset($stripeConfig['public_api_key'])) {
            throw new ParameterNotSetException('When payment.provide is stripe then payments.stripe.public_api_key needs to be provided');
        }

        return $stripeConfig;
    }

    /**
     * @throws ParameterNotSetException
     */
    private function configureStripeSuccessUrl(mixed $stripeConfig): mixed
    {
        if (!isset($stripeConfig['success_url'])) {
            throw new ParameterNotSetException('When payment.provide is stripe then payments.stripe.success_url needs to be provided');
        }

        return $stripeConfig;
    }

    /**
     * @throws ParameterNotSetException
     */
    private function configureCancelUrl(mixed $stripeConfig): mixed
    {
        if (!isset($stripeConfig['cancel_url'])) {
            throw new ParameterNotSetException('When payment.provide is stripe then payments.stripe.cancel_url needs to be provided');
        }

        return $stripeConfig;
    }

    /**
     * @throws ParameterNotSetException
     */
    private function configureSubscriberType(array $config, ContainerBuilder $containerBuilder): array
    {
        if (isset($config['payments']['subscriptions']['subscriber_type'])) {
            if (SubscriberInterface::TYPE_USER == $config['payments']['subscriptions']['subscriber_type']) {
                $containerBuilder->setAlias(SubscriberRepositoryInterface::class, UserRepositoryInterface::class);

                // Remove TeamSubscriberSection so only UserSubscriberSection remains
                $containerBuilder->removeDefinition(TeamSubscriberSection::class);
            } elseif (SubscriberInterface::TYPE_TEAM == $config['payments']['subscriptions']['subscriber_type']) {
                $containerBuilder->setAlias(SubscriberRepositoryInterface::class, TeamRepositoryInterface::class);

                // Remove TeamSubscriberSection so only UserSubscriberSection remains
                $containerBuilder->removeDefinition(UserSubscriberSection::class);
            } else {
                throw new ParameterNotSetException('Invalid setting for payment.subscriptions.subscriber_type');
            }

            $containerBuilder->setParameter('parthenon_payments_subscriber_type', $config['payments']['subscriptions']['subscriber_type']);
        }

        return $config;
    }

    private function getPlansNode(): NodeDefinition
    {
        $treeBuilder = new TreeBuilder('plan');
        $node = $treeBuilder->getRootNode();

        /** @var ArrayNodeDefinition $planNode */
        $planNode = $node
            ->requiresAtLeastOneElement()
            ->useAttributeAsKey('name')
            ->prototype('array');

        $planNode
            ->fixXmlConfig('limits')
            ->children()
            ->booleanNode('is_free')->defaultFalse()->end()
            ->booleanNode('is_per_seat')->defaultFalse()->end()
            ->/** @scrutinizer ignore-call */ booleanNode('is_per_seat')->defaultFalse()->end()
            ->scalarNode('user_count')->end()
            ->arrayNode('features')
            ->scalarPrototype()->end()
            ->end()
            ->arrayNode('limit')
            ->useAttributeAsKey('name')
            ->prototype('array')
            ->children()
            ->integerNode('limit')->end()
            ->scalarNode('description')->end()
            ->end()
            ->end()
            ->end()
            ->end();

        return $node;
    }
}

getparthenon / parthenon

Payments::configureSuccessRedirectRoute() A last analyzed 2025-01-23 10:56 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Payments::configureSuccessRedirectRoute() A
last analyzed 2025-01-23 10:56 UTC
