Merge pull request #200 from adamwojs/fix_deprecated_tree_builder_root_call

Fixed deprecated TreeBuilder::root method call in SF 4

Controller/CaptchaController.php

@@ -2,7 +2,7 @@
 
 namespace Gregwar\CaptchaBundle\Controller;
 
-use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
@@ -11,7 +11,7 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  *
  * @author Jeremy Livingston <jeremy.j.livingston@gmail.com>
  */
-class CaptchaController extends Controller
+class CaptchaController extends AbstractController
 {
     /**
      * Action that is used to generate the captcha, save its code, and stream the image

DependencyInjection/Configuration.php

@@ -14,8 +14,14 @@ class Configuration implements ConfigurationInterface
      */
     public function getConfigTreeBuilder()
     {
-        $treeBuilder = new TreeBuilder();
-        $rootNode = $treeBuilder->root('gregwar_captcha');
+        $treeBuilder = new TreeBuilder('gregwar_captcha');
+
+        if (method_exists($treeBuilder, 'getRootNode')) {
+            $rootNode = $treeBuilder->getRootNode();
+        } else {
+            // BC for symfony/config <= 4.1
+            $rootNode = $treeBuilder->root('gregwar_captcha');
+        }
 
         $rootNode
             ->addDefaultsIfNotSet()
@@ -47,6 +53,7 @@ class Configuration implements ConfigurationInterface
                 ->arrayNode('background_images')->prototype('scalar')->end()->end()
                 ->scalarNode('disabled')->defaultValue(false)->end()
                 ->scalarNode('ignore_all_effects')->defaultValue(false)->end()
+                ->scalarNode('session_key')->defaultValue('captcha')->end()
             ->end()
         ;
 

Resources/config/routing/routing.yml

@@ -1,3 +1,3 @@
 gregwar_captcha.generate_captcha:
     path:           /generate-captcha/{key}
-    defaults:       { _controller: GregwarCaptchaBundle:Captcha:generateCaptcha }
+    defaults:       { _controller: Gregwar\CaptchaBundle\Controller\CaptchaController::generateCaptchaAction }

Resources/views/captcha.html.twig

@@ -2,7 +2,7 @@
 {% if is_human %}
 -
 {% else %}
-{% spaceless %}
+{% apply spaceless %}
     <img class="captcha_image" id="{{ image_id }}" src="{{ captcha_code }}" alt="" title="captcha" width="{{ captcha_width }}" height="{{ captcha_height }}" />
     {% if reload %}
     <script type="text/javascript">
@@ -14,6 +14,6 @@
     <a class="captcha_reload" href="javascript:reload_{{ image_id }}();">{{ 'Renew'|trans({}, 'gregwar_captcha') }}</a>
     {% endif %}
     {{ form_widget(form) }}
-{% endspaceless %}
+{% endapply %}
 {% endif %}
 {% endblock %}

Type/CaptchaType.php

@@ -22,6 +22,8 @@ use Gregwar\CaptchaBundle\Generator\CaptchaGenerator;
  */
 class CaptchaType extends AbstractType
 {
+    const SESSION_KEY_PREFIX = '_captcha_';
+
     /**
      * @var SessionInterface
      */
@@ -53,7 +55,7 @@ class CaptchaType extends AbstractType
     {
         $this->session      = $session;
         $this->generator    = $generator;
-        $this->translator = $translator;
+        $this->translator   = $translator;
         $this->options      = $options;
     }
 
@@ -65,7 +67,7 @@ class CaptchaType extends AbstractType
         $validator = new CaptchaValidator(
             $this->translator,
             $this->session,
-            sprintf('gcb_%s', $builder->getForm()->getName()),
+            sprintf('%s%s', self::SESSION_KEY_PREFIX, $options['session_key']),
             $options['invalid_message'],
             $options['bypass_code'],
             $options['humanity']
@@ -83,7 +85,7 @@ class CaptchaType extends AbstractType
             throw new \InvalidArgumentException('GregwarCaptcha: The reload option cannot be set without as_url, see the README for more information');
         }
 
-        $sessionKey = sprintf('gcb_%s', $form->getName());
+        $sessionKey = sprintf('%s%s', self::SESSION_KEY_PREFIX, $options['session_key']);
         $isHuman    = false;
 
         if ($options['humanity'] > 0) {

composer.json

@@ -20,7 +20,8 @@
         "php": ">=5.3.9",
         "gregwar/captcha": "~1.1",
         "symfony/framework-bundle": "~2.8|~3.0|~4.0",
-        "symfony/form": "~2.8|~3.0|~4.0"
+        "symfony/form": "~2.8|~3.0|~4.0",
+        "twig/twig": "^1.40|^2.9"
     },
     "autoload": {
         "psr-4": {