Ynlo\GraphQLBundle\Mutation\AbstractMutationResolver

Complexity

Total Complexity

27

Size/Duplication

Total Lines	176
Duplicated Lines	0 %

Test Coverage

Coverage

94.03%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
B	createDefinitionForm()	0	23	4
A	postValidation()	0	2	1
A	onSubmit()	0	2	1
A	preValidate()	0	2	1
D	extractFormErrors()	0	40	10
D	__invoke()	0	39	10

<?php
/*******************************************************************************
 *  This file is part of the GraphQL Bundle package.
 *
 *  (c) YnloUltratech <support@ynloultratech.com>
 *
 *  For the full copyright and license information, please view the LICENSE
 *  file that was distributed with this source code.
 ******************************************************************************/

namespace Ynlo\GraphQLBundle\Mutation;

use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\Validator\ConstraintViolation as SymfonyConstraintViolation;
use Ynlo\GraphQLBundle\Form\DataTransformer\DataWithIdToNodeTransformer;
use Ynlo\GraphQLBundle\Model\ConstraintViolation;
use Ynlo\GraphQLBundle\Resolver\AbstractResolver;
use Ynlo\GraphQLBundle\Validator\ConstraintViolationList;

/**
 * Base class for mutations
 * Implement the method "process()" and "returnPayload()" is enough in many scenarios
 */
abstract class AbstractMutationResolver extends AbstractResolver
{
    /**
     * @param array $input
     *
     * @return mixed
     */
    public function __invoke($input)
    {
        $formBuilder = $this->createDefinitionForm($input);

        $form = null;
        if ($formBuilder) {
            $form = $formBuilder->getForm();
        }

        $this->preValidate($input);
        if ($form) {
            $form->submit($input, false);
            $data = $form->getData();
        } else {
            $data = $input;
        }

        $this->onSubmit($input, $data);

        $violations = new ConstraintViolationList();
        if ($form) {
            $this->extractFormErrors($form, $violations);
        }
        $this->postValidation($data, $violations);

        $dryRun = $input['dryRun'] ?? false;

        if ($dryRun) {
            $data = null;
        } else {
            if ((!$form && !$violations->count())
                || ($form->isSubmitted() && $form->isValid() && !$violations->count())
            ) {

                $this->process($data);
            }
        }

        return $this->returnPayload($data, $violations, $input);
    }

    /**
     * Actions to process
     * the result processed data is given to payload
     *
     * @param mixed $data
     */
    abstract protected function process(&$data);

    /**
     * The payload object or array matching the GraphQL definition
     *
     * @param mixed                   $data        normalized data, its the input data processed by the form
     * @param ConstraintViolationList $violations  violations returned by the form validation process
     * @param array                   $inputSource the original submitted data in array
     *
     * @return mixed
     */
    abstract protected function returnPayload($data, ConstraintViolationList $violations, $inputSource);

    /**
     * @param mixed $data
     *
     * @return FormBuilderInterface|null
     */
    protected function createDefinitionForm($data): ?FormBuilderInterface
    {
        if (!$this->context->getDefinition()->hasMeta('form')) {
            return null;
        }

        $formConfig = $this->context->getDefinition()->getMeta('form') ?? [];
        $formType = $formConfig['type'] ?? null;
        if (!$formConfig || !$formType) {
            throw new \RuntimeException(sprintf('Can`t find a valid form for %s', $this->context->getDefinition()->getName()));
        }

        $options = [
            'csrf_protection' => false,
            'allow_extra_fields' => true,
        ];

        $options = array_merge($options, $formConfig['options'] ?? []);
        $form = $this->createFormBuilder($formType, $data, $options);
        $viewTransformer = new DataWithIdToNodeTransformer($this->getManager(), $this->context->getEndpoint());
        $form->addViewTransformer($viewTransformer);

        return $form;
    }

    /**
     * @param FormInterface           $form
     * @param ConstraintViolationList $violations
     * @param null|string             $parentName
     */
    protected function extractFormErrors(FormInterface $form, ConstraintViolationList $violations, ?string $parentName = null)
    {
        $errors = $form->getErrors();
        foreach ($errors as $error) {
            $violation = new ConstraintViolation();

            $path = null;
            if ($form->getParent()) {
                $path = $form->getName();
            }
            if ($parentName) {

The expression $parentName of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

                $path = $parentName.'.'.$form->getName();
            }

            $violation->setPropertyPath($path);
            $violation->setMessage($error->getMessage());

The method getMessage() does not exist on Symfony\Component\Form\FormErrorIterator.

            $violation->setMessageTemplate($error->getMessageTemplate());

The method getMessageTemplate() does not exist on Symfony\Component\Form\FormErrorIterator.

            foreach ($error->getMessageParameters() as $key => $value) {

The method getMessageParameters() does not exist on Symfony\Component\Form\FormErrorIterator.

                $violation->addParameter($key, $value);
            }

            $cause = $error->getCause();

The method getCause() does not exist on Symfony\Component\Form\FormErrorIterator.

            if ($cause instanceof SymfonyConstraintViolation) {
                $violation->setCode($cause->getCode());
                $violation->setInvalidValue($cause->getInvalidValue());
                $violation->setPlural($cause->getPlural());
            }

            $violations->addViolation($violation);
        }
        if ($form->all()) {
            foreach ($form->all() as $child) {
                $parentName = $form->getName();

                //avoid set the name of the form
                if ($form->getName() === $parentName && !$form->getParent()) {
                    $parentName = null;
                }

                $this->extractFormErrors($child, $violations, $parentName);
            }
        }
    }

    /**
     * Can use this method to verify if submitted data is valid
     * otherwise can trow a error
     *
     * @param mixed $inputSource contain the original submitted input data
     * @param mixed $normData    contains the processed and normalized data by the form
     */
    protected function onSubmit($inputSource, &$normData)

The parameter $normData is not used and could be removed.

The parameter $inputSource is not used and could be removed.

    {
        //override in child
    }

    /**
     * Can do something before validate the submitted data
     *
     * @param mixed $data
     */
    protected function preValidate(&$data)

The parameter $data is not used and could be removed.

    {
        //override in child
    }

    /**
     * Can use this to add your custom validations errors
     *
     * @param mixed                   $data
     * @param ConstraintViolationList $violations
     */
    protected function postValidation($data, ConstraintViolationList $violations)

The parameter $violations is not used and could be removed.

The parameter $data is not used and could be removed.

    {
        //override in child
    }
}