EmbedHelper::convertExceptionToFormError() - Code Metrics - zicht/framework-extra-bundle - Measure and Improve Code Quality continuously with Scrutinizer

EmbedHelper::convertExceptionToFormError() A
last analyzed 2020-10-09 07:32 UTC

↳ Parent: EmbedHelper
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
<?php
/**
 * @author Gerard van Helden <[email protected]>
 * @copyright Zicht Online <http://zicht.nl>
 */
namespace Zicht\Bundle\FrameworkExtraBundle\Helper;

use Symfony\Component\DependencyInjection\Container;
use Symfony\Component\Form\FormError;
use Symfony\Component\Form\FormView;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\Form\Form;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\Form\FormErrorIterator;
use Symfony\Component\HttpFoundation\Session\SessionInterface;
use Zicht\Bundle\FrameworkExtraBundle\Http\JsonResponse;
use Zicht\Bundle\FrameworkExtraBundle\Url\UrlCheckerService;

/**
 * Helper class to facilitate embedded forms in ESI with redirection handling.
 */
class EmbedHelper
{
    /**
     * Service container
     *
     * @var \Symfony\Component\DependencyInjection\Container
     */
    protected $container;

    /**
     * Whether or not to consider exceptions thrown by the handler as formerrors.
     *
     * @var bool
     */
    protected $isMarkExceptionsAsFormErrors;


    /**
     * Construct the helper with the service container.
     *
     * @param \Symfony\Component\DependencyInjection\Container $container
     * @param bool $markExceptionsAsFormErrors
     */
    public function __construct(Container $container, $markExceptionsAsFormErrors = false)
    {
        $this->container = $container;
        $this->isMarkExceptionsAsFormErrors = $markExceptionsAsFormErrors;
    }

    /**
     * Get the top most (root) element of the form view
     *
     * @param FormView $formView
     * @return mixed
     */
    public static function getFormRoot($formView)
    {
        $parent = $formView;
        while (isset($parent->parent)) {
            $parent = $parent->parent;
        }
        return $parent;
    }


    /**
     * Generate an embedded url, adding the embedded parameters to the url
     *
     * @param string $route
     * @param array $params
     * @return string
     */
    public function url($route, $params)
    {
        // use array filter to remove keys with null values
        $params += array_filter($this->getEmbedParams());

        return $this->container->get('router')->generate($route, $params);
    }


    /**
     * Returns the parameters to add to an embedded url from the current request.
     *
     * @return array
     */
    public function getEmbedParams($checkSafety = true)
    {
        $params = array('return_url' => null, 'success_url' => null, 'do' => null);

        if ($returnUrl = $this->container->get('request')->get('return_url')) {
            $params['return_url'] = $checkSafety ? $this->container->get(UrlCheckerService::class)->getSafeUrl($returnUrl) : $returnUrl;
        }
        if ($successUrl = $this->container->get('request')->get('success_url')) {
            $params['success_url'] = $checkSafety ? $this->container->get(UrlCheckerService::class)->getSafeUrl($successUrl) : $successUrl;
        }
        // eg: do=change
        if ($doAction = $this->container->get('request')->get('do')) {
            $params['do'] = $doAction;
        }

        return $params;
    }


    /**
     * Handles a form and executes a callback to do definite handling.
     *
     * The embed helper utilizes a way to store the form state of a form after submitting, so when including a form
     * in an ESI, the form state is kept until the next display of the form. When using the handleForm with
     * XmlHttpRequests, the form state is not stored, since it is assumed the response will be used to display the
     * data directly.
     *
     * The return value is either a Response object that can be returned as the result of the action, or it is an
     * array which can be used in a template.
     *
     * @param \Symfony\Component\Form\Form $form
     * @param \Symfony\Component\HttpFoundation\Request $request
     * @param \callback $handlerCallback
     * @param string $formTargetRoute
     * @param array $formTargetParams
     * @param array $extraViewVars
     * @return array|Response
     * @throws \Exception
     */
    public function handleForm(
        Form $form,
        Request $request,
        $handlerCallback,
        $formTargetRoute,
        $formTargetParams = array(),
        $extraViewVars = array()
    ) {
        $formId = $this->getFormId($form);
        if ($request->hasPreviousSession()) {
            // cannot store errors iterator in session because somewhere there is a closure that can't be serialized
            // therefore convert the errors iterator to array, on get from session convert to iterator
            // see [1]

            $formState = $request->getSession()->get($formId);
            $formState['form_errors'] = is_array($formState['form_errors']) ? $formState['form_errors'] : array();
            $formState['form_errors'] = new FormErrorIterator($form, $formState['form_errors']);
        } else {
            $formState = null;
        }
        $formStatus = '';


        // This only binds the form, so the event listeners are triggered, but no actual submit-handling is done.
        // This is useful for AJAX requests which need to modify the form based on submitted data.
        if ($request->get('_submit_type') === 'bind') {
            $form->submit($request);
        } elseif ($request->getMethod() == 'POST') {
            $form->submit($request);

            $returnUrl     = $this->container->get(UrlCheckerService::class)->getSafeUrl($request->get('return_url'));
            $successUrl    = $this->container->get(UrlCheckerService::class)->getSafeUrl($request->get('success_url'));

            $handlerResult = false;



            // if it is valid, we can use the callback to handle the actual handling
            if ($form->isValid()) {
                try {
                    $handlerResult = call_user_func($handlerCallback, $request, $form, $this->container);
                } catch (\Exception $e) {
                    if (!$this->isMarkExceptionsAsFormErrors) {
                        throw $e;
                    } else {
                        $form->addError($this->convertExceptionToFormError($e));
                    }
                }

                if ($handlerResult) {
                    // any lingering errors may be removed now.
                    unset($formState['has_errors']);
                    unset($formState['data']);
                    unset($formState['form_errors']);
                    $formStatus = 'ok';

                    if ($handlerResult && $handlerResult instanceof Response) {
                        return $handlerResult;
                    } elseif (is_array($handlerResult)) {
                        $extraViewVars = $handlerResult + $extraViewVars;
                    }
                    if ($successUrl) {
                        $returnUrl = $successUrl;

                        if ($request->isXmlHttpRequest()) {
                            return new JsonResponse(array('success_url' => $successUrl));
                            return /** @scrutinizer ignore-deprecated */ new JsonResponse(array('success_url' => $successUrl));
                        }
                    } else {
                        // we set a convenience flash message if there was no success url, because
                        // we will probably return to the return url re-displaying the form.
                        $this->setFlashMessage($form, 'confirmed', $request->getSession());
                    }
                } else {
                    $formStatus = 'errors';

                    $formState['has_errors']  = true;
                    $formState['data']        = $request->request->get($form->getName());
                    $formState['form_errors'] = $form->getErrors();
                }
            } else {
                $formStatus = 'errors';

                $formState['has_errors']  = true;
                $formState['data']        = $request->request->get($form->getName());
                $formState['form_errors'] = $form->getErrors();
            }
            // redirect to the return url, if available
            if ($returnUrl && !$request->isXmlHttpRequest()) {
                $response = new RedirectResponse($returnUrl);
            }
        } elseif (!empty($formState['has_errors'])) {
            $formStatus = 'errors';

            // see if there were any errors left in the session from a previous post, so we show them
            if (!empty($formState['data']) && is_array($formState['data'])) {
                $form->submit($formState['data']);
                unset($formState['data']);
            }
            if (!empty($formState['form_errors'])) {
                foreach ($formState['form_errors'] as $error) {
                    $form->addError($error);
                }
            }
            // and we only show them once.
            unset($formState['has_errors']);
            unset($formState['form_errors']);
        }

        if ($formState && !$request->isXmlHttpRequest()) {
            if (!empty($formState['form_errors'])) {

                // 1. You cannot serialize or un-serialize PDO instances
                // 2. We do not want to store cause and origin in the session since these can become quite large
                foreach ($formState['form_errors'] as $key => $error) {
                    $refObject = new \ReflectionObject($error);
                    $refCauseProperty = $refObject->getProperty('cause');
                    $refCauseProperty->setAccessible(true);
                    $refCauseProperty->setValue($error, null);
                    $refOriginProperty = $refObject->getProperty('origin');
                    $refOriginProperty->setAccessible(true);
                    $refOriginProperty->setValue($error, null);
                }
            }

            // see [1] for explanation
            if (!isset($formState['form_errors'])) {
                $formState['form_errors'] = [];
            } elseif ($formState['form_errors'] instanceof \Traversable) {
                $formState['form_errors'] = iterator_to_array($formState['form_errors']);
            }

            $request->getSession()->set($formId, $formState);
        } elseif ($request->hasPreviousSession()) {
            $request->getSession()->remove($formId);
        }

        $viewVars = $extraViewVars;

        if (empty($response)) {
            if ($request->get('extension')) {
                $formTargetParams += array(
                    'extension' => $request->get('extension')
                );
            }
            $viewVars['form_status'] = $formStatus;

            $viewVars['form_url'] = $this->url($formTargetRoute, $formTargetParams);
            $viewVars['form']     = $form->createView();

            $prefix = '';
            if ($root = self::getFormRoot($viewVars['form'])) {
                $prefix = sprintf('form_messages.%s.', strtolower($root->vars['name']));
            }

            $viewVars['messages'] = [];
            if ($request->hasPreviousSession() && ($messages = $this->container->get('session')->getFlashBag()->get($formId))) {
                foreach ($messages as $value) {
                    $viewVars['messages'][] = $prefix . $value;
                }
            }


            return $viewVars;
        }

        return $response;
    }


    /**
     * Returns the ID the form's state is stored by in the session
     *
     * @param \Symfony\Component\Form\FormInterface $form
     * @return mixed
     */
    public function getFormId(FormInterface $form)
    {
        if (is_object($form->getData())) {
            $ret = preg_replace('/\W/', '_', get_class($form->getData()));
        } else {
            if ($form->getName()) {
                return (string)$form->getName();
            } else {
                return preg_replace('/\W/', '_', get_class($form));
            }
        }
        
        return $ret;
    }


    /**
     * @param bool $markExceptionsAsFormErrors
     */
    public function setMarkExceptionsAsFormErrors($markExceptionsAsFormErrors)
    {
        $this->isMarkExceptionsAsFormErrors = $markExceptionsAsFormErrors;
    }


    /**
     * Provides a way of customizing error messages based on type of exception, etc.
     *
     * @param \Exception $exception
     * @return FormError
     */
    protected function convertExceptionToFormError($exception)
    {
        return new FormError($exception->getMessage());
    }

    /**
     * A generic way to set flash messages.
     *
     * When using this make sure you set the following parameter in your parameters.yml to avoid stacking of messages
     * when they are not shown or rendered in templates
     *
     *     session.flashbag.class: Symfony\Component\HttpFoundation\Session\Flash\AutoExpireFlashBag
     *
     * Messages will be pushed to a viewVars called 'messages' see $this->handleForm
     *
     * @param Form $form
     * @param string $message
     */
    public function setFlashMessage(Form $form, $message, SessionInterface $session = null)
    {
        if (null === $session) {
            trigger_error(
                "Please do not rely on the container's instance of the session, but fetch it from the Request",
                E_USER_DEPRECATED
            );
            $session = $this->container->get('session');
        }
        $session->getFlashBag()->set($this->getFormId($form), $message);
    }
}

zicht / framework-extra-bundle

EmbedHelper::convertExceptionToFormError() A last analyzed 2020-10-09 07:32 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

EmbedHelper::convertExceptionToFormError() A
last analyzed 2020-10-09 07:32 UTC
