PaymentForm::extendPyzPaymentCollection() - Code Metrics - Inspection of "Merge pull request #45 from spryker-shop/release-2..." - spryker-shop/b2b-demo-marketplace - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 321221...bff5d9 )

by Dmitry
created 2022-12-20 14:29 UTC
PaymentForm::extendPyzPaymentCollection() A

↳ Parent: PaymentForm
Complexity

Conditions	2
Paths	2
Size

Total Lines	14
Code Lines	6
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	6
dl	0
loc	14
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	2
<?php

/**
 * This file is part of the Spryker Commerce OS.
 * For full license information, please view the LICENSE file that was distributed with this source code.
 */

namespace Pyz\Yves\CheckoutPage\Form\Steps;

use Generated\Shared\Transfer\PaymentMethodsTransfer;
use Generated\Shared\Transfer\PaymentTransfer;
use Generated\Shared\Transfer\QuoteTransfer;
use Pyz\Yves\StepEngine\Dependency\Form\SubFormInterface as PyzSubFormInterface;
use Pyz\Yves\StepEngine\Dependency\Form\SubFormProviderNameInterface as PyzSubFormProviderNameInterface;
use Spryker\Yves\Kernel\Form\AbstractType;
use Spryker\Yves\StepEngine\Dependency\Form\SubFormProviderNameInterface as SprykerSubFormProviderNameInterface;
use Spryker\Yves\StepEngine\Dependency\Plugin\Form\SubFormPluginCollection;
use Spryker\Yves\StepEngine\Dependency\Plugin\Form\SubFormPluginInterface;
use SprykerShop\Yves\CheckoutPage\Form\StepEngine\ExtraOptionsSubFormInterface;
use SprykerShop\Yves\CheckoutPage\Form\StepEngine\StandaloneSubFormInterface;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\Constraints\NotBlank;

/**
 * @method \SprykerShop\Yves\CheckoutPage\CheckoutPageFactory getFactory()
 * @method \Pyz\Yves\CheckoutPage\CheckoutPageConfig getConfig()
 */
class PaymentForm extends AbstractType
{
    /**
     * @var string
     */
    public const PYZ_PAYMENT_PROPERTY_PATH = QuoteTransfer::PAYMENT;

    /**
     * @var string
     */
    public const PYZ_PAYMENT_SELECTION = PaymentTransfer::PAYMENT_SELECTION;

    /**
     * @var string
     */
    public const PYZ_PAYMENT_SELECTION_PROPERTY_PATH = self::PYZ_PAYMENT_PROPERTY_PATH . '.' . self::PYZ_PAYMENT_SELECTION;

    /**
     * @var string
     */
    protected const PYZ_VALIDATION_NOT_BLANK_MESSAGE = 'validation.not_blank';

    /**
     * @return string
     */
    public function getBlockPrefix(): string
    {
        return 'paymentForm';
    }

    /**
     * @param \Symfony\Component\Form\FormBuilderInterface $builder
     * @param array $options
     *
     * @return void
     */
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $this->addPyzPaymentMethods($builder, $options);
    }

    /**
     * @param \Symfony\Component\OptionsResolver\OptionsResolver $resolver
     *
     * @return void
     */
    public function configureOptions(OptionsResolver $resolver): void
    {
        $resolver->setDefaults([
            'validation_groups' => function (FormInterface $form) {
                $validationGroups = [Constraint::DEFAULT_GROUP];

                $paymentSelectionFormData = $form->get(self::PYZ_PAYMENT_SELECTION)->getData();
                if (is_string($paymentSelectionFormData)) {
                    $validationGroups[] = $paymentSelectionFormData;
                }

                return $validationGroups;
            },
            'attr' => [
                'novalidate' => 'novalidate',
            ],
        ]);

        $resolver->setRequired(PyzSubFormInterface::PYZ_OPTIONS_FIELD_NAME);
    }

    /**
     * @param \Symfony\Component\Form\FormBuilderInterface $builder
     * @param array<\Spryker\Yves\StepEngine\Dependency\Form\SubFormInterface|\Pyz\Yves\StepEngine\Dependency\Form\SubFormInterface> $paymentMethodSubForms
     * @param array $options
     *
     * @return $this
     */
    protected function addPyzPaymentMethodSubForms(FormBuilderInterface $builder, array $paymentMethodSubForms, array $options)
    {
        foreach ($paymentMethodSubForms as $paymentMethodSubForm) {
            $paymentMethodSubFormOptions = $this->getPyzPaymentMethodSubFormOptions($paymentMethodSubForm);

            $builder->add(
                $this->getPyzSubFormName($paymentMethodSubForm),
                get_class($paymentMethodSubForm),
                ['select_options' => $options['select_options']] + $paymentMethodSubFormOptions,
            );
        }

        return $this;
    }

    /**
     * @param \Spryker\Yves\StepEngine\Dependency\Form\SubFormInterface|\Pyz\Yves\StepEngine\Dependency\Form\SubFormInterface $paymentMethodSubForm
     *
     * @return array<mixed>
     */
    protected function getPyzPaymentMethodSubFormOptions($paymentMethodSubForm): array
    {
        $defaultOptions = [
            'property_path' => static::PYZ_PAYMENT_PROPERTY_PATH . '.' . $this->getPyzSubFormPropertyPath($paymentMethodSubForm),
            'error_bubbling' => true,
            'label' => false,
        ];

        if (!$paymentMethodSubForm instanceof ExtraOptionsSubFormInterface) {
            return $defaultOptions;
        }

        return $defaultOptions + $paymentMethodSubForm->getExtraOptions();
        return $defaultOptions + $paymentMethodSubForm->/** @scrutinizer ignore-call */ getExtraOptions();
    }

    /**
     * @param \Symfony\Component\Form\FormBuilderInterface $builder
     * @param array $options
     *
     * @return $this
     */
    protected function addPyzPaymentMethods(FormBuilderInterface $builder, array $options)
    {
        $paymentMethodSubForms = $this->getPyzPaymentMethodSubForms();

        $this->addPyzPaymentMethodChoices($builder, $paymentMethodSubForms)
            ->addPyzPaymentMethodSubForms($builder, $paymentMethodSubForms, $options);

        return $this;
    }

    /**
     * @param \Symfony\Component\Form\FormBuilderInterface $builder
     * @param array<\Spryker\Yves\StepEngine\Dependency\Form\SubFormInterface|\Pyz\Yves\StepEngine\Dependency\Form\SubFormInterface> $paymentMethodSubForms
     *
     * @return $this
     */
    protected function addPyzPaymentMethodChoices(FormBuilderInterface $builder, array $paymentMethodSubForms)
    {
        $builder->add(
            static::PYZ_PAYMENT_SELECTION,
            ChoiceType::class,
            [
                'choices' => $this->getPyzPaymentMethodChoices($paymentMethodSubForms),
                'choice_name' => function ($choice, $key) use ($paymentMethodSubForms) {
                    $paymentMethodSubForm = $paymentMethodSubForms[$key];

                    return $this->getPyzSubFormName($paymentMethodSubForm);
                },
                'choice_label' => function ($choice, $key) use ($paymentMethodSubForms) {
                    $paymentMethodSubForm = $paymentMethodSubForms[$key];

                    if ($paymentMethodSubForm instanceof StandaloneSubFormInterface) {
                        return $paymentMethodSubForm->getLabelName();
                        return $paymentMethodSubForm->/** @scrutinizer ignore-call */ getLabelName();
                    }

                    return $this->getPyzSubFormName($paymentMethodSubForm);
                },
                'group_by' => function ($choice, $key) use ($paymentMethodSubForms) {
                    $paymentMethodSubForm = $paymentMethodSubForms[$key];

                    if ($paymentMethodSubForm instanceof StandaloneSubFormInterface) {
                        return $paymentMethodSubForm->getGroupName();
                        return $paymentMethodSubForm->/** @scrutinizer ignore-call */ getGroupName();
                    }

                    if ($paymentMethodSubForm instanceof SprykerSubFormProviderNameInterface) {
                        return sprintf('checkout.payment.provider.%s', $paymentMethodSubForm->getProviderName());
                        return sprintf('checkout.payment.provider.%s', $paymentMethodSubForm->/** @scrutinizer ignore-call */ getProviderName());
                    }

                    if ($paymentMethodSubForm instanceof PyzSubFormProviderNameInterface) {
                        return sprintf('checkout.payment.provider.%s', $paymentMethodSubForm->getPyzProviderName());
                    }

                    return '';
                },
                'label' => false,
                'required' => true,
                'expanded' => true,
                'multiple' => false,
                'placeholder' => false,
                'property_path' => static::PYZ_PAYMENT_SELECTION_PROPERTY_PATH,
                'constraints' => [
                    $this->createPyzNotBlankConstraint(),
                ],
            ],
        );

        return $this;
    }

    /**
     * @return array<\Spryker\Yves\StepEngine\Dependency\Form\SubFormInterface|\Pyz\Yves\StepEngine\Dependency\Form\SubFormInterface>
     */
    protected function getPyzPaymentMethodSubForms(): array
    {
        $paymentMethodSubForms = [];

        $availablePaymentMethodsTransfer = $this->getFactory()->createPaymentMethodReader()
            ->getAvailablePaymentMethods();

        $availablePaymentMethodSubFormPlugins = $this->getFactory()->getPaymentMethodSubForms();
        $availablePaymentMethodSubFormPlugins = $this->filterPyzOutNotAvailableForms(
            $availablePaymentMethodSubFormPlugins,
            $availablePaymentMethodsTransfer,
        );
        $availablePaymentMethodSubFormPlugins = $this->extendPyzPaymentCollection(
            $availablePaymentMethodSubFormPlugins,
            $availablePaymentMethodsTransfer,
        );
        $filteredPaymentMethodSubFormPlugins = $this->filterPyzPaymentMethodSubFormPlugins($availablePaymentMethodSubFormPlugins);

        foreach ($filteredPaymentMethodSubFormPlugins as $paymentMethodSubFormPlugin) {
            $paymentMethodSubForm = $this->createPyzSubForm($paymentMethodSubFormPlugin);
            $paymentMethodSubForms[$this->getPyzSubFormName($paymentMethodSubForm)] = $paymentMethodSubForm;
        }

        return $paymentMethodSubForms;
    }

    /**
     * @param \Spryker\Yves\StepEngine\Dependency\Plugin\Form\SubFormPluginCollection $paymentSubFormPluginCollection
     * @param \Generated\Shared\Transfer\PaymentMethodsTransfer $paymentMethodsTransfer
     *
     * @return \Spryker\Yves\StepEngine\Dependency\Plugin\Form\SubFormPluginCollection
     */
    protected function extendPyzPaymentCollection(
        SubFormPluginCollection $paymentSubFormPluginCollection,
        PaymentMethodsTransfer $paymentMethodsTransfer
    ): SubFormPluginCollection {
        $paymentCollectionExtenderPlugins = $this->getFactory()->getPaymentCollectionExtenderPlugins();

        foreach ($paymentCollectionExtenderPlugins as $paymentCollectionExtenderPlugin) {
            $paymentSubFormPluginCollection = $paymentCollectionExtenderPlugin->extendCollection(
                $paymentSubFormPluginCollection,
                $paymentMethodsTransfer,
            );
        }

        return $paymentSubFormPluginCollection;
    }

    /**
     * @param \Spryker\Yves\StepEngine\Dependency\Plugin\Form\SubFormPluginCollection $paymentMethodSubFormPlugins
     * @param \Generated\Shared\Transfer\PaymentMethodsTransfer $availablePaymentMethodsTransfer
     *
     * @return \Spryker\Yves\StepEngine\Dependency\Plugin\Form\SubFormPluginCollection
     */
    protected function filterPyzOutNotAvailableForms(
        SubFormPluginCollection $paymentMethodSubFormPlugins,
        PaymentMethodsTransfer $availablePaymentMethodsTransfer
    ): SubFormPluginCollection {
        $paymentMethodNames = $this->getPyzAvailablePaymentMethodNames($availablePaymentMethodsTransfer);
        $paymentMethodNames = array_combine($paymentMethodNames, $paymentMethodNames);

        foreach ($paymentMethodSubFormPlugins as $key => $subFormPlugin) {
            $subFormName = $this->getPyzSubFormName($subFormPlugin->createSubForm());

            if (!isset($paymentMethodNames[$subFormName])) {
                unset($paymentMethodSubFormPlugins[$key]);
            }
        }

        $paymentMethodSubFormPlugins->reset();

        return $paymentMethodSubFormPlugins;
    }

    /**
     * @param \Generated\Shared\Transfer\PaymentMethodsTransfer $availablePaymentMethodsTransfer
     *
     * @return array<string>
     */
    protected function getPyzAvailablePaymentMethodNames(PaymentMethodsTransfer $availablePaymentMethodsTransfer): array
    {
        $paymentMethodNames = [];
        foreach ($availablePaymentMethodsTransfer->getMethods() as $paymentMethodTransfer) {
            $paymentMethodNames[] = $paymentMethodTransfer->getMethodName();
        }

        return $paymentMethodNames;
    }

    /**
     * @param array<\Spryker\Yves\StepEngine\Dependency\Form\SubFormInterface|\Pyz\Yves\StepEngine\Dependency\Form\SubFormInterface> $paymentMethodSubForms
     *
     * @return array<string, string>
     */
    protected function getPyzPaymentMethodChoices(array $paymentMethodSubForms): array
    {
        $choices = [];

        foreach ($paymentMethodSubForms as $paymentMethodSubForm) {
            $choices[$this->getPyzSubFormName($paymentMethodSubForm)] = $this->getPyzSubFormPropertyPath($paymentMethodSubForm);
        }

        return $choices;
    }

    /**
     * @param \Spryker\Yves\StepEngine\Dependency\Plugin\Form\SubFormPluginCollection $availablePaymentMethodSubFormPlugins
     *
     * @return \Spryker\Yves\StepEngine\Dependency\Plugin\Form\SubFormPluginCollection
     */
    protected function filterPyzPaymentMethodSubFormPlugins(SubFormPluginCollection $availablePaymentMethodSubFormPlugins): SubFormPluginCollection
    {
        return $this->getFactory()
            ->createSubFormFilter()
            ->filterFormsCollection($availablePaymentMethodSubFormPlugins);
    }

    /**
     * @return \Symfony\Component\Validator\Constraints\NotBlank
     */
    protected function createPyzNotBlankConstraint(): NotBlank
    {
        return new NotBlank(['message' => static::PYZ_VALIDATION_NOT_BLANK_MESSAGE]);
    }

    /**
     * @param \Spryker\Yves\StepEngine\Dependency\Plugin\Form\SubFormPluginInterface $paymentMethodSubForm
     *
     * @return \Spryker\Yves\StepEngine\Dependency\Form\SubFormInterface|\Pyz\Yves\StepEngine\Dependency\Form\SubFormInterface
     */
    protected function createPyzSubForm(SubFormPluginInterface $paymentMethodSubForm)
    {
        /** @var \Spryker\Yves\StepEngine\Dependency\Form\SubFormInterface|\Pyz\Yves\StepEngine\Dependency\Form\SubFormInterface $paymentSubForm */
        $paymentSubForm = $paymentMethodSubForm->createSubForm();

        return $paymentSubForm;
    }

    /**
     * @param \Spryker\Yves\StepEngine\Dependency\Form\SubFormInterface|\Pyz\Yves\StepEngine\Dependency\Form\SubFormInterface $paymentSubForm
     *
     * @return string
     */
    protected function getPyzSubFormName($paymentSubForm): string
    {
        if ($paymentSubForm instanceof PyzSubFormInterface) {
            return $paymentSubForm->getPyzName();
        }

        return $paymentSubForm->getName();
    }

    /**
     * @param \Spryker\Yves\StepEngine\Dependency\Form\SubFormInterface|\Pyz\Yves\StepEngine\Dependency\Form\SubFormInterface $paymentSubForm
     *
     * @return string
     */
    protected function getPyzSubFormPropertyPath($paymentSubForm): string
    {
        if ($paymentSubForm instanceof PyzSubFormInterface) {
            return $paymentSubForm->getPyzPropertyPath();
        }

        return $paymentSubForm->getPropertyPath();
    }
}

spryker-shop / b2b-demo-marketplace

Push — master ( 321221...bff5d9 )

PaymentForm::extendPyzPaymentCollection() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
