Add missing initialization

php 8 support

Controller/CaptchaController.php

@@ -1,31 +1,37 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Gregwar\CaptchaBundle\Controller;
 
+use Gregwar\CaptchaBundle\Generator\CaptchaGenerator;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 
 /**
- * Generates a captcha via a URL
+ * Generates a captcha via a URL.
  *
  * @author Jeremy Livingston <jeremy.j.livingston@gmail.com>
  */
-class CaptchaController extends Controller
+class CaptchaController extends AbstractController
 {
-    /**
+    /** @var CaptchaGenerator */
-     * Action that is used to generate the captcha, save its code, and stream the image
+    private $captchaGenerator;
-     *
+
-     * @param \Symfony\Component\HttpFoundation\Request $request
+    /** @var array */
-     * @param string $key
+    private $config;
-     *
+
-     * @return \Symfony\Component\HttpFoundation\Response
+    public function __construct(CaptchaGenerator $captchaGenerator, array $config)
-     */
-    public function generateCaptchaAction(Request $request, $key)
     {
-        $options = $this->container->getParameter('gregwar_captcha.config');
+        $this->captchaGenerator = $captchaGenerator;
-        $session = $this->get('session');
+        $this->config = $config;
-        $whitelistKey = $options['whitelist_key'];
+    }
+
+    public function generateCaptchaAction(Request $request, string $key): Response
+    {
+        $session = $request->getSession();
+        $whitelistKey = $this->config['whitelist_key'];
         $isOk = false;
 
         if ($session->has($whitelistKey)) {
@@ -36,24 +42,35 @@ class CaptchaController extends Controller
         }
 
         if (!$isOk) {
-            throw $this->createNotFoundException('Unable to generate a captcha via an URL with this session key.');
+            return $this->error($this->config);
         }
 
-        /* @var \Gregwar\CaptchaBundle\Generator\CaptchaGenerator $generator */
-        $generator = $this->container->get('gregwar_captcha.generator');
-
         $persistedOptions = $session->get($key, array());
-        $options = array_merge($options, $persistedOptions);
+        $options = array_merge($this->config, $persistedOptions);
 
-        $phrase = $generator->getPhrase($options);
+        $phrase = $this->captchaGenerator->getPhrase($options);
-        $generator->setPhrase($phrase);
+        $this->captchaGenerator->setPhrase($phrase);
         $persistedOptions['phrase'] = $phrase;
         $session->set($key, $persistedOptions);
 
-        $response = new Response($generator->generate($options));
+        $response = new Response($this->captchaGenerator->generate($options));
         $response->headers->set('Content-type', 'image/jpeg');
+        $response->headers->set('Pragma', 'no-cache');
+        $response->headers->set('Cache-Control', 'no-cache');
+
+        return $response;
+    }
+
+    private function error(array $options): Response
+    {
+        $this->captchaGenerator->setPhrase('');
+
+        $response = new Response($this->captchaGenerator->generate($options));
+        $response->setStatusCode(428);
+        $response->headers->set('Content-type', 'image/jpeg');
+        $response->headers->set('Pragma', 'no-cache');
+        $response->headers->set('Cache-Control', 'no-cache');
 
         return $response;
     }
 }
-

DependencyInjection/Configuration.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Gregwar\CaptchaBundle\DependencyInjection;
 
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
@@ -7,15 +9,10 @@ use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 class Configuration implements ConfigurationInterface
 {
-    /**
+    public function getConfigTreeBuilder(): TreeBuilder
-     * Generates the configuration tree.
-     *
-     * @return TreeBuilder
-     */
-    public function getConfigTreeBuilder()
     {
-        $treeBuilder = new TreeBuilder();
+        $treeBuilder = new TreeBuilder('gregwar_captcha');
-        $rootNode = $treeBuilder->root('gregwar_captcha');
+        $rootNode = $treeBuilder->getRootNode();
 
         $rootNode
             ->addDefaultsIfNotSet()
@@ -30,10 +27,10 @@ class Configuration implements ConfigurationInterface
                 ->scalarNode('as_url')->defaultValue(false)->end()
                 ->scalarNode('reload')->defaultValue(false)->end()
                 ->scalarNode('image_folder')->defaultValue('captcha')->end()
-                ->scalarNode('web_path')->defaultValue('%kernel.root_dir%/../web')->end()
+                ->scalarNode('web_path')->defaultValue('%kernel.project_dir%/public')->end()
                 ->scalarNode('gc_freq')->defaultValue(100)->end()
                 ->scalarNode('expiration')->defaultValue(60)->end()
-                ->scalarNode('quality')->defaultValue(30)->end()
+                ->scalarNode('quality')->defaultValue(50)->end()
                 ->scalarNode('invalid_message')->defaultValue('Bad code value')->end()
                 ->scalarNode('bypass_code')->defaultValue(null)->end()
                 ->scalarNode('whitelist_key')->defaultValue('captcha_whitelist_key')->end()
@@ -44,11 +41,13 @@ class Configuration implements ConfigurationInterface
                 ->scalarNode('interpolation')->defaultValue(true)->end()
                 ->arrayNode('text_color')->prototype('scalar')->end()->end()
                 ->arrayNode('background_color')->prototype('scalar')->end()->end()
+                ->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()
         ;
 
         return $treeBuilder;
     }
 }
-

DependencyInjection/GregwarCaptchaExtension.php

@@ -1,24 +1,29 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Gregwar\CaptchaBundle\DependencyInjection;
 
+use Exception;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 use Symfony\Component\Config\FileLocator;
 
 /**
- * Extension used to load the configuration, set parameters, and initialize the captcha view
+ * Extension used to load the configuration, set parameters, and initialize the captcha view.
  *
  * @author Gregwar <g.passault@gmail.com>
  */
 class GregwarCaptchaExtension extends Extension
 {
     /**
-     * @param array $configs
+     * @param array            $configs
-     * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
+     * @param ContainerBuilder $container
+     *
+     * @throws Exception
      */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('services.yml');
@@ -34,6 +39,6 @@ class GregwarCaptchaExtension extends Extension
         $container->setParameter('gregwar_captcha.config.whitelist_key', $config['whitelist_key']);
 
         $resources = $container->getParameter('twig.form.resources');
-        $container->setParameter('twig.form.resources', array_merge(array('GregwarCaptchaBundle::captcha.html.twig'), $resources));
+        $container->setParameter('twig.form.resources', array_merge(array('@GregwarCaptcha/captcha.html.twig'), $resources));
     }
 }

Generator/CaptchaGenerator.php

@@ -1,64 +1,54 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Gregwar\CaptchaBundle\Generator;
 
-use Symfony\Component\Finder\Finder;
+use Gregwar\Captcha\CaptchaBuilder;
-use Symfony\Component\HttpFoundation\Session\SessionInterface;
+use Gregwar\Captcha\PhraseBuilder;
 use Symfony\Component\Routing\RouterInterface;
-
 use Gregwar\Captcha\CaptchaBuilderInterface;
 use Gregwar\Captcha\PhraseBuilderInterface;
 
 /**
- * Uses configuration parameters to call the services that generate captcha images
+ * Uses configuration parameters to call the services that generate captcha images.
  *
  * @author Gregwar <g.passault@gmail.com>
  * @author Jeremy Livingston <jeremy.j.livingston@gmail.com>
  */
 class CaptchaGenerator
 {
-    /**
+    /** @var RouterInterface */
-     * @var \Symfony\Component\Routing\RouterInterface
-     */
     protected $router;
 
-    /**
+    /** @var CaptchaBuilder */
-     * @var CaptchaBuilder
-     */
     protected $builder;
 
-    /**
+    /** @var PhraseBuilder */
-     * @var PhraseBuilder
-     */
     protected $phraseBuilder;
 
-    /**
+    /** @var ImageFileHandler */
-     * @var ImageFileHandler
-     */
     protected $imageFileHandler;
 
     /**
-     * @param \Symfony\Component\Routing\RouterInterface $router
+     * @param RouterInterface         $router
      * @param CaptchaBuilderInterface $builder
-     * @param ImageFileHandlerInterface $imageFileHandler
+     * @param PhraseBuilderInterface  $phraseBuilder
+     * @param ImageFileHandler        $imageFileHandler
      */
-    public function __construct(RouterInterface $router, CaptchaBuilderInterface $builder, PhraseBuilderInterface $phraseBuilder, ImageFileHandler $imageFileHandler)
+    public function __construct(
-    {
+        RouterInterface $router,
-        $this->router           = $router;
+        CaptchaBuilderInterface $builder,
-        $this->builder          = $builder;
+        PhraseBuilderInterface $phraseBuilder,
-        $this->phraseBuilder    = $phraseBuilder;
+        ImageFileHandler $imageFileHandler
-        $this->imageFileHandler = $imageFileHandler;    
+    ) {
+        $this->router = $router;
+        $this->builder = $builder;
+        $this->phraseBuilder = $phraseBuilder;
+        $this->imageFileHandler = $imageFileHandler;
     }
 
-    /**
+    public function getCaptchaCode(array &$options): string
-     * Get the captcha URL, stream, or filename that will go in the image's src attribute
-     *
-     * @param $key
-     * @param array $options
-     *
-     * @return array
-     */
-    public function getCaptchaCode(array &$options)
     {
         $this->builder->setPhrase($this->getPhrase($options));
 
@@ -71,27 +61,21 @@ class CaptchaGenerator
 
         // Returns the image generation URL
         if ($options['as_url']) {
-            return $this->router->generate('gregwar_captcha.generate_captcha', array('key' => $options['session_key']));
+            return $this->router->generate(
+                'gregwar_captcha.generate_captcha',
+                array('key' => $options['session_key'], 'n' => md5(microtime(true).mt_rand()))
+            );
         }
 
-        return 'data:image/jpeg;base64,' . base64_encode($this->generate($options));
+        return 'data:image/jpeg;base64,'.base64_encode($this->generate($options));
     }
 
-    /**
+    public function setPhrase(string $phrase): void
-     * Sets the phrase to the builder
-     */
-    public function setPhrase($phrase)
     {
         $this->builder->setPhrase($phrase);
     }
 
-    /**
+    public function generate(array &$options): string
-     * @param string $key
-     * @param array $options
-     *
-     * @return string
-     */
-    public function generate(array &$options)
     {
         $this->builder->setDistortion($options['distortion']);
 
@@ -99,7 +83,7 @@ class CaptchaGenerator
         $this->builder->setMaxBehindLines($options['max_behind_lines']);
 
         if (isset($options['text_color']) && $options['text_color']) {
-            if (count($options['text_color']) !== 3) {
+            if (3 !== count($options['text_color'])) {
                 throw new \RuntimeException('text_color should be an array of r, g and b');
             }
 
@@ -108,7 +92,7 @@ class CaptchaGenerator
         }
 
         if (isset($options['background_color']) && $options['background_color']) {
-            if (count($options['background_color']) !== 3) {
+            if (3 !== count($options['background_color'])) {
                 throw new \RuntimeException('background_color should be an array of r, g and b');
             }
 
@@ -120,6 +104,9 @@ class CaptchaGenerator
 
         $fingerprint = isset($options['fingerprint']) ? $options['fingerprint'] : null;
 
+        $this->builder->setBackgroundImages($options['background_images']);
+        $this->builder->setIgnoreAllEffects($options['ignore_all_effects']);
+
         $content = $this->builder->build(
             $options['width'],
             $options['height'],
@@ -141,13 +128,7 @@ class CaptchaGenerator
         return $this->imageFileHandler->saveAsFile($content);
     }
 
-    /**
+    public function getPhrase(array &$options): string
-     * @param string $key
-     * @param array $options
-     *
-     * @return string
-     */
-    public function getPhrase(array &$options)
     {
         // Get the phrase that we'll use for this image
         if ($options['keep_value'] && isset($options['phrase'])) {
@@ -156,8 +137,7 @@ class CaptchaGenerator
             $phrase = $this->phraseBuilder->build($options['length'], $options['charset']);
             $options['phrase'] = $phrase;
         }
-        
+
         return $phrase;
     }
 }
-

Generator/ImageFileHandler.php

@@ -1,11 +1,13 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Gregwar\CaptchaBundle\Generator;
 
 use Symfony\Component\Finder\Finder;
 
 /**
- * Handles actions related to captcha image files including saving and garbage collection
+ * Handles actions related to captcha image files including saving and garbage collection.
  *
  * @author Gregwar <g.passault@gmail.com>
  * @author Jeremy Livingston <jeremy@quizzle.com>
@@ -13,69 +15,61 @@ use Symfony\Component\Finder\Finder;
 class ImageFileHandler
 {
     /**
-     * Name of folder for captcha images
+     * Name of folder for captcha images.
+     *
      * @var string
      */
     protected $imageFolder;
 
     /**
-     * Absolute path to public web folder
+     * Absolute path to public web folder.
+     *
      * @var string
      */
     protected $webPath;
 
     /**
-     * Frequency of garbage collection in fractions of 1
+     * Frequency of garbage collection in fractions of 1.
+     *
      * @var int
      */
     protected $gcFreq;
 
     /**
-     * Maximum age of images in minutes
+     * Maximum age of images in minutes.
+     *
      * @var int
      */
     protected $expiration;
 
     /**
-     * @param $imageFolder
+     * @param string $imageFolder
-     * @param $webPath
+     * @param string $webPath
-     * @param $gcFreq
+     * @param string $gcFreq
-     * @param $expiration
+     * @param string $expiration
      */
-    public function __construct($imageFolder, $webPath, $gcFreq, $expiration)
+    public function __construct(string $imageFolder, string $webPath, string $gcFreq, string $expiration)
     {
-        $this->imageFolder      = $imageFolder;
+        $this->imageFolder = $imageFolder;
-        $this->webPath          = $webPath;
+        $this->webPath = $webPath;
-        $this->gcFreq           = $gcFreq;
+        $this->gcFreq = $gcFreq;
-        $this->expiration       = $expiration;
+        $this->expiration = $expiration;
     }
 
-    /**
+    public function saveAsFile($contents): string
-     * Saves the provided image content as a file
-     *
-     * @param string $contents
-     *
-     * @return string
-     */
-    public function saveAsFile($contents)
     {
         $this->createFolderIfMissing();
 
-        $filename = md5(uniqid()) . '.jpg';
+        $filename = md5(uniqid()).'.jpg';
-        $filePath = $this->webPath . '/' . $this->imageFolder . '/' . $filename;
+        $filePath = $this->webPath.'/'.$this->imageFolder.'/'.$filename;
         imagejpeg($contents, $filePath, 15);
 
-        return '/' . $this->imageFolder . '/' . $filename;
+        return '/'.$this->imageFolder.'/'.$filename;
     }
 
-    /**
+    public function collectGarbage(): bool
-     * Randomly runs garbage collection on the image directory
-     *
-     * @return bool
-     */
-    public function collectGarbage()
     {
-        if (!mt_rand(1, $this->gcFreq) == 1) {
+        if (1 == !mt_rand(1, $this->gcFreq)) {
             return false;
         }
 
@@ -83,24 +77,20 @@ class ImageFileHandler
 
         $finder = new Finder();
         $criteria = sprintf('<= now - %s minutes', $this->expiration);
-        $finder->in($this->webPath . '/' . $this->imageFolder)
+        $finder->in($this->webPath.'/'.$this->imageFolder)
             ->date($criteria);
 
-        foreach($finder->files() as $file) {
+        foreach ($finder->files() as $file) {
             unlink($file->getPathname());
         }
 
         return true;
     }
 
-    /**
+    protected function createFolderIfMissing(): void
-     * Creates the folder if it doesn't exist
-     */
-    protected function createFolderIfMissing()
     {
-        if (!file_exists($this->webPath . '/' . $this->imageFolder)) {
+        if (!file_exists($this->webPath.'/'.$this->imageFolder)) {
-            mkdir($this->webPath . '/' . $this->imageFolder, 0755);
+            mkdir($this->webPath.'/'.$this->imageFolder, 0755);
         }
     }
 }
-

GregwarCaptchaBundle.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Gregwar\CaptchaBundle;
 
 use Symfony\Component\HttpKernel\Bundle\Bundle;

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) <2011-2013> Grégoire Passault
+Copyright (c) <2011-2015> Grégoire Passault
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,109 +1,66 @@
 Gregwar's CaptchaBundle
 =====================
 
-The `GregwarCaptchaBundle` adds support for a "captcha" form type for the
+[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=YUXRLWHQSWS6L)
-Symfony2 form component.
+
+The `GregwarCaptchaBundle` adds support for a captcha form type for the
+Symfony form component.
+
+It uses [gregwar/captcha](https://github.com/Gregwar/Captcha) as captcha generator, which is a separate standalone library that can be used for none-symfony projects.
+
+Compatibility with Symfony
+==========================
+
+| CaptchaBundle   | Symfony   | PHP      |
+|:---------------:|:---------:|:--------:|
+| 2.1.*           | 4.* - 5.* | >= 7.1   |
+| 2.0.*           | 2.8 - 3.* | >= 5.3.9 |
+| 1.*             | 2.1 - 2.7 | >= 5.3.0 |
 
-Important note: the master of this repository is containing current development
-in order to work with Symfony 2.1. If you are using Symfony 2.0 please checkout
-the 2.0 branch.
 
 Installation
 ============
 
 ### Step 1: Download the GregwarCaptchaBundle
 
-Ultimately, the GregwarCaptchaBundle files should be downloaded to the
+Use composer require to download and install the package. 
-'vendor/bundles/Gregwar/CaptchaBundle' directory.
+At the end of the installation, the bundle is automatically registered thanks to the Symfony recipe.
-
-You can accomplish this several ways, depending on your personal preference.
-The first method is the standard Symfony2 method.
-
-***Using the vendors script***
-
-Add the following lines to your `deps` file:
-
-```
-    [GregwarCaptchaBundle]
-        git=http://github.com/Gregwar/CaptchaBundle.git
-        target=/bundles/Gregwar/CaptchaBundle
-        version=origin/2.0 <- add this if you are using Symfony 2.0
-```
-
-Now, run the vendors script to download the bundle:
 
 ``` bash
-$ php bin/vendors install
+    composer require gregwar/captcha-bundle
 ```
 
-***Using submodules***
+If you don't use flex, register it manually:
-
-If you prefer instead to use git submodules, then run the following:
-
-``` bash
-$ git submodule add git://github.com/Gregwar/CaptchaBundle.git vendor/bundles/Gregwar/CaptchaBundle
-$ git submodule update --init
-```
-
-***Using Composer***
-
-Add the following to the "require" section of your `composer.json` file:
-
-```
-    "gregwar/captcha-bundle": "dev-master"
-```
-
-And update your dependencies
-
-### Step 2: Configure the Autoloader
-
-If you use composer, you can skip this step.
-
-Now you will need to add the `Gregwar` namespace to your autoloader:
-
-``` php
-<?php
-// app/autoload.php
-
-$loader->registerNamespaces(array(
-    // ...
-    'Gregwar' => __DIR__.'/../vendor/bundles',
-));
-```
-### Step 3: Enable the bundle
-
-Finally, enable the bundle in the kernel:
-
 ```php
 <?php
-// app/appKernel.php
+// config/bundles.php
-
+return [
-public function registerBundles()
+    // ...
-{
+    Gregwar\CaptchaBundle\GregwarCaptchaBundle::class => ['all' => true]
-    $bundles = array(
+];
-        // ...
-        new Gregwar\CaptchaBundle\GregwarCaptchaBundle(),
-    );
-}
 ```
 
 Configuration
 =============
 
-Add the following configuration to your `app/config/config.yml`:
+If you need to customize the global bundle configuration, you can create a  `/config/packages/gregwar_captcha.yaml` file with your configuration:
-
+``` yaml
-    gregwar_captcha: ~
+gregwar_captcha:
+  width: 160
+  height: 50
+```
 
 Usage
 =====
 
 You can use the "captcha" type in your forms this way:
 
-```php
+``` php
 <?php
-    // ...
+use Gregwar\CaptchaBundle\Type\CaptchaType;
-    $builder->add('captcha', 'captcha'); // That's all !
+// ...
-    // ...
+$builder->add('captcha', CaptchaType::class); // That's all !
+// ...
 ```
 
 Note that the generated image will, by default, be embedded in the HTML document
@@ -115,7 +72,7 @@ Options
 You can define the following configuration options globally:
 
 * **image_folder**: name of folder for captcha images relative to public web folder in case **as_file** is set to true (default="captcha")
-* **web_path**: absolute path to public web folder (default="%kernel.root_dir%/../web")
+* **web_path**: absolute path to public web folder (default='%kernel.project_dir%/public')
 * **gc_freq**: frequency of garbage collection in fractions of 1 (default=100)
 * **expiration**: maximum lifetime of captcha image files in minutes (default=60)
 
@@ -126,7 +83,7 @@ You can define the following configuration options globally or on the CaptchaTyp
 * **disabled**: disable globally the CAPTCHAs (can be useful in dev environment), it will
   still appear but won't be editable and won't be checked
 * **length**: the length of the captcha (number of chars, default 5)
-* **quality**: jpeg quality of captchas (default=15)
+* **quality**: jpeg quality of captchas (default=30)
 * **charset**: the charset used for code generation (default=abcdefhjkmnprstuvwxyz23456789)
 * **font**: the font to use (default is random among some pre-provided fonts), this should be an absolute path
 * **keep_value**: the value will be the same until the form is posted, even if the page is refreshed (default=true)
@@ -141,27 +98,32 @@ You can define the following configuration options globally or on the CaptchaTyp
 * **max_front_lines**, **max_behind_lines**: the maximum number of lines to draw on top/behind the image. `0` will draw no lines; `null` will use the default algorithm (the
 number of lines depends on the size of the image). (default=null)
 * **background_color**: sets the background color, if you want to force it, this should be an array of r,g &b, for instance [255, 255, 255] will force the background to be white
+* **background_images**: Sets custom user defined images as the captcha background (1 image is selected randomly). It is recommended to turn off all the effects on the image (ignore_all_effects). The full paths to the images must be passed.
 * **interpolation**: enable or disable the interpolation on the captcha
+* **ignore_all_effects**: Recommended to use when setting background images, will disable all image effects.
+* **session_key**, if you want to host multiple CAPTCHA on the same page, you might have different session keys to ensure proper storage of the clear phrase for those different forms
 
 Example :
 
-```php
+``` php
 <?php
-    // ...
+use Gregwar\CaptchaBundle\Type\CaptchaType;
-    $builder->add('captcha', 'captcha', array(
+// ...
-        'width' => 200,
+$builder->add('captcha', CaptchaType::class, array(
-        'height' => 50,
+    'width' => 200,
-        'length' => 6,
+    'height' => 50,
-    ));
+    'length' => 6,
+));
 ```
 
 You can also set these options for your whole application using the `gregwar_captcha`
 configuration entry in your `config.yml` file:
-
+``` yaml 
-    gregwar_captcha:
+gregwar_captcha:
-        width: 200
+    width: 200
-        height: 50
+    height: 50
-        length: 6
+    length: 6
+```
 
 Translation
 ===========
@@ -170,16 +132,20 @@ The messages are using the translator, you can either change the `invalid_messag
 
 As URL
 ============
-To use a URL to generate a captcha image, you must add the bundle's routing configuration to your app/routing.yml file:
+To use a URL to generate a captcha image, you must add the bundle's routing configuration to your `config/routes.yaml` file:
 
-    gregwar_captcha_routing:
+``` yaml 
-        resource: "@GregwarCaptchaBundle/Resources/config/routing/routing.yml"
+gregwar_captcha_routing:
+    resource: "@GregwarCaptchaBundle/Resources/config/routing/routing.yml"
+```
 
-This will use the bundle's route of "/generate-captcha/{key}" to handle the generation. If this route conflicts with an application route, you can prefix the bundle's routes when you import:
+This will use the bundle's route of `/generate-captcha/{key}` to handle the generation. If this route conflicts with an application route, you can prefix the bundle's routes when you import:
 
-    gregwar_captcha_routing:
+``` yaml 
-        resource: "@GregwarCaptchaBundle/Resources/config/routing/routing.yml"
+gregwar_captcha_routing:
-        prefix: /_gcb
+    resource: "@GregwarCaptchaBundle/Resources/config/routing/routing.yml"
+    prefix: /_gcb
+```
 
 Since the session key is transported in the URL, it's also added in another session array, under the `whitelist_key` key, for security reasons
 
@@ -190,7 +156,7 @@ The widget support the standard Symfony theming, see the [documentation](http://
 
 The default rendering is:
 
-```html
+``` twig
 {% block captcha_widget %}
 {% spaceless %}
     <img src="{{ captcha_code }}" title="captcha" width="{{ captcha_width }}" height="{{ captcha_height }}" />

Resources/config/routing/routing.yml

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

Resources/config/services.yml

@@ -1,32 +1,58 @@
+parameters:
+    gregwar_captcha.controller.class: Gregwar\CaptchaBundle\Controller\CaptchaController
+    gregwar_captcha.captcha_type.class: Gregwar\CaptchaBundle\Type\CaptchaType
+    gregwar_captcha.captcha_generator.class: Gregwar\CaptchaBundle\Generator\CaptchaGenerator
+    gregwar_captcha.image_file_handler.class: Gregwar\CaptchaBundle\Generator\ImageFileHandler
+    gregwar_captcha.captcha_builder.class: Gregwar\Captcha\CaptchaBuilder
+    gregwar_captcha.phrase_builder.class: Gregwar\Captcha\PhraseBuilder
+    
 services:
-    captcha.type:
+    Gregwar\CaptchaBundle\Controller\CaptchaController:
-        class: Gregwar\CaptchaBundle\Type\CaptchaType
+        public: true
+        alias: 'gregwar_captcha.controller'
+
+    gregwar_captcha.controller:
+        class: '%gregwar_captcha.controller.class%'
+        public: true
         arguments:
-            - @session
+            - '@gregwar_captcha.generator'
-            - @gregwar_captcha.generator
+            - '%gregwar_captcha.config%'
-            - @translator
+        autowire: true
-            - %gregwar_captcha.config%
+
+#    captcha.type:
+    gregwar_captcha.type:
+        class: '%gregwar_captcha.captcha_type.class%'
+        public: true
+        arguments:
+            - '@session'
+            - '@gregwar_captcha.generator'
+            - '@translator'
+            - '%gregwar_captcha.config%'
         tags:
             - { name: form.type, alias: captcha }
 
     gregwar_captcha.generator:
-        class: Gregwar\CaptchaBundle\Generator\CaptchaGenerator
+        class: '%gregwar_captcha.captcha_generator.class%'
+        public: true
         arguments:
-            - @router
+            - '@router'
-            - @gregwar_captcha.captcha_builder
+            - '@gregwar_captcha.captcha_builder'
-            - @gregwar_captcha.phrase_builder
+            - '@gregwar_captcha.phrase_builder'
-            - @gregwar_captcha.image_file_handler
+            - '@gregwar_captcha.image_file_handler'
 
     gregwar_captcha.image_file_handler:
-        class: Gregwar\CaptchaBundle\Generator\ImageFileHandler
+        class: '%gregwar_captcha.image_file_handler.class%'
+        public: true
         arguments:
-            - %gregwar_captcha.config.image_folder%
+            - '%gregwar_captcha.config.image_folder%'
-            - %gregwar_captcha.config.web_path%
+            - '%gregwar_captcha.config.web_path%'
-            - %gregwar_captcha.config.gc_freq%
+            - '%gregwar_captcha.config.gc_freq%'
-            - %gregwar_captcha.config.expiration%
+            - '%gregwar_captcha.config.expiration%'
 
     gregwar_captcha.captcha_builder:
-        class: Gregwar\Captcha\CaptchaBuilder
+        class: '%gregwar_captcha.captcha_builder.class%'
+        public: true
 
     gregwar_captcha.phrase_builder:
-        class: Gregwar\Captcha\PhraseBuilder
+        class: '%gregwar_captcha.phrase_builder.class%'
+        public: true

Resources/translations/gregwar_captcha.ar.yml

@@ -0,0 +1 @@
+Renew: تجديد

Resources/translations/gregwar_captcha.bg.yml

@@ -0,0 +1 @@
+Renew: Обнови

Resources/translations/gregwar_captcha.cs.yml

@@ -0,0 +1 @@
+Renew: Obnovit

Resources/translations/gregwar_captcha.pl.yml

@@ -0,0 +1 @@
+Renew: Przeładuj

Resources/translations/gregwar_captcha.tr.yml

@@ -0,0 +1 @@
+Renew: Yenile

Resources/translations/gregwar_captcha.uk.yml

@@ -0,0 +1 @@
+Renew: Оновити

Resources/translations/validators.ar.yml

@@ -0,0 +1 @@
+Bad code value: الرمز غير متطابق

Resources/translations/validators.bg.yml

@@ -0,0 +1 @@
+Bad code value: Грешен код

Resources/translations/validators.cs.yml

@@ -0,0 +1 @@
+Bad code value: Špatný kontrolní kód

Resources/translations/validators.pl.yml

@@ -0,0 +1 @@
+Bad code value: Kod jest niepoprawny

Resources/translations/validators.tr.yml

@@ -0,0 +1 @@
+Bad code value: Kod eşleşmiyor

Resources/translations/validators.uk.yml

@@ -0,0 +1 @@
+Bad code value: Невірний код

Resources/views/captcha.html.twig

@@ -2,8 +2,8 @@
 {% if is_human %}
 -
 {% else %}
-{% spaceless %}
+{% apply spaceless %}
-    <img id="{{ image_id }}" src="{{ captcha_code }}" alt="" title="captcha" width="{{ captcha_width }}" height="{{ captcha_height }}" />
+    <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">
         function reload_{{ image_id }}() {
@@ -14,7 +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

@@ -1,155 +1,142 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Gregwar\CaptchaBundle\Type;
 
+use Symfony\Component\Form\Extension\Core\Type\TextType;
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
 use Symfony\Component\Form\FormView;
 use Symfony\Component\Form\FormInterface;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\FormBuilderInterface;
-use Symfony\Component\OptionsResolver\OptionsResolverInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
 use Symfony\Component\Form\FormEvents;
-use Symfony\Component\Translation\TranslatorInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
-
 use Gregwar\CaptchaBundle\Validator\CaptchaValidator;
 use Gregwar\CaptchaBundle\Generator\CaptchaGenerator;
 
 /**
- * Captcha type
+ * Captcha type.
  *
  * @author Gregwar <g.passault@gmail.com>
  */
 class CaptchaType extends AbstractType
 {
-    /**
+    const SESSION_KEY_PREFIX = '_captcha_';
-     * @var \Symfony\Component\HttpFoundation\Session\SessionInterface
+
-     */
+    /** @var SessionInterface */
     protected $session;
 
-    /**
+    /** @var CaptchaGenerator */
-     * The session key
-     * @var string
-     */
-    protected $key = null;
-
-    /**
-     * @var \Gregwar\CaptchaBundle\Generator\CaptchaGenerator
-     */
     protected $generator;
 
-    /**
+    /** @var TranslatorInterface */
-     * @var TranslatorInterface
-     */
     protected $translator;
 
-    /**
+    /** @var array */
-     * Options
-     * @var array
-     */
     private $options = array();
 
     /**
-     * @param \Symfony\Component\HttpFoundation\Session\SessionInterface $session
+     * @param SessionInterface    $session
-     * @param \Gregwar\CaptchaBundle\Generator\CaptchaGenerator $generator
+     * @param CaptchaGenerator    $generator
-     * @param array $options
+     * @param TranslatorInterface $translator
+     * @param array               $options
      */
     public function __construct(SessionInterface $session, CaptchaGenerator $generator, TranslatorInterface $translator, $options)
     {
-        $this->session      = $session;
+        $this->session = $session;
-        $this->generator    = $generator;
+        $this->generator = $generator;
         $this->translator = $translator;
-        $this->options      = $options;
+        $this->options = $options;
     }
 
     /**
-     * @param \Symfony\Component\Form\FormBuilderInterface $builder
+     * {@inheritdoc}
-     * @param array $options
      */
     public function buildForm(FormBuilderInterface $builder, array $options)
     {
-        $this->key = 'gcb_'.$builder->getForm()->getName();
-
         $validator = new CaptchaValidator(
             $this->translator,
             $this->session,
-            $this->key,
+            sprintf('%s%s', self::SESSION_KEY_PREFIX, $options['session_key']),
             $options['invalid_message'],
             $options['bypass_code'],
-            $options['humanity']
+            $options['humanity'],
+            $options['request']
         );
 
-        $builder->addEventListener(FormEvents::POST_BIND, array($validator, 'validate'));
+        $builder->addEventListener(FormEvents::POST_SUBMIT, array($validator, 'validate'));
     }
 
     /**
-     * @param \Symfony\Component\Form\FormView $view
+     * {@inheritdoc}
-     * @param \Symfony\Component\Form\FormInterface $form
-     * @param array $options
      */
     public function buildView(FormView $view, FormInterface $form, array $options)
     {
-        $isHuman = false;
-
         if ($options['reload'] && !$options['as_url']) {
             throw new \InvalidArgumentException('GregwarCaptcha: The reload option cannot be set without as_url, see the README for more information');
         }
 
+        $sessionKey = sprintf('%s%s', self::SESSION_KEY_PREFIX, $options['session_key']);
+        $isHuman = false;
+
         if ($options['humanity'] > 0) {
-            $humanityKey = $this->key.'_humanity';
+            $humanityKey = sprintf('%s_humanity', $sessionKey);
             if ($this->session->get($humanityKey, 0) > 0) {
                 $isHuman = true;
             }
         }
 
         if ($options['as_url']) {
-            $key = $this->key;
             $keys = $this->session->get($options['whitelist_key'], array());
-            if (!in_array($key, $keys)) {
+            if (!in_array($sessionKey, $keys)) {
-                $keys[] = $key;
+                $keys[] = $sessionKey;
             }
             $this->session->set($options['whitelist_key'], $keys);
-            $options['session_key'] = $this->key;
+            $options['session_key'] = $sessionKey;
         }
 
         $view->vars = array_merge($view->vars, array(
-            'captcha_width'     => $options['width'],
+            'captcha_width' => $options['width'],
-            'captcha_height'    => $options['height'],
+            'captcha_height' => $options['height'],
-            'reload'            => $options['reload'],
+            'reload' => $options['reload'],
-            'image_id'          => uniqid('captcha_'),
+            'image_id' => uniqid('captcha_'),
-            'captcha_code'      => $this->generator->getCaptchaCode($options),
+            'captcha_code' => $this->generator->getCaptchaCode($options),
-            'value'             => '',
+            'value' => '',
-            'is_human'          => $isHuman
+            'is_human' => $isHuman,
         ));
 
         $persistOptions = array();
-        foreach (array('phrase', 'width', 'height', 'distortion', 'length', 'quality') as $key) {
+        foreach (array('phrase', 'width', 'height', 'distortion', 'length',
+        'quality', 'background_color', 'background_images', 'text_color', ) as $key) {
             $persistOptions[$key] = $options[$key];
         }
 
-        $this->session->set($this->key, $persistOptions);
+        $this->session->set($sessionKey, $persistOptions);
     }
 
     /**
-     * @param \Symfony\Component\OptionsResolver\OptionsResolverInterface $resolver
+     * {@inheritdoc}
      */
-    public function setDefaultOptions(OptionsResolverInterface $resolver)
+    public function configureOptions(OptionsResolver $resolver)
     {
         $this->options['mapped'] = false;
+        $this->options['request'] = null;
         $resolver->setDefaults($this->options);
     }
 
-    /**
+    public function getParent(): string
-     * @return string
-     */
-    public function getParent()
     {
-        return 'text';
+        return TextType::class;
     }
 
-    /**
+    public function getName(): string
-     * @return string
+    {
-     */
+        return $this->getBlockPrefix();
-    public function getName()
+    }
+
+    public function getBlockPrefix(): string
     {
         return 'captcha';
     }

Validator/CaptchaValidator.php

@@ -1,73 +1,88 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Gregwar\CaptchaBundle\Validator;
 
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
 use Symfony\Component\Form\FormError;
 use Symfony\Component\Form\FormEvent;
-use Symfony\Component\Translation\TranslatorInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
+use Symfony\Component\HttpFoundation\Request;
 
 /**
- * Captcha validator
+ * Captcha validator.
  *
  * @author Gregwar <g.passault@gmail.com>
  */
 class CaptchaValidator
 {
-    /**
+    /** @var SessionInterface */
-     * @var \Symfony\Component\HttpFoundation\Session\SessionInterface
-     */
     private $session;
 
     /**
-     * Session key to store the code
+     * Session key to store the code.
+     *
+     * @var string
      */
     private $key;
 
     /**
-     * Error message text for non-matching submissions
+     * Error message text for non-matching submissions.
+     *
+     * @var string
      */
     private $invalidMessage;
 
     /**
-     * Configuration parameter used to bypass a required code match
+     * Configuration parameter used to bypass a required code match.
+     *
+     * @var string
      */
     private $bypassCode;
 
     /**
-     * Number of form that the user can submit without captcha
+     * Number of form that the user can submit without captcha.
+     *
      * @var int
      */
     private $humanity;
 
     /**
-     * Translator
+     * Translator.
+     *
      * @var TranslatorInterface
      */
     private $translator;
 
     /**
-     * @param \Symfony\Component\HttpFoundation\Session\SessionInterface $session
+     * Request
-     * @param string $key
+     *
-     * @param string $invalidMessage
+     * @var Request
-     * @param string|null $bypassCode
      */
-    public function __construct(TranslatorInterface $translator, SessionInterface $session, $key, $invalidMessage, $bypassCode, $humanity)
+    private $req;
-    {
+
-        $this->translator       = $translator;
+    public function __construct(
-        $this->session          = $session;
+        TranslatorInterface $translator,
-        $this->key              = $key;
+        SessionInterface $session,
-        $this->invalidMessage   = $invalidMessage;
+        string $key,
-        $this->bypassCode       = $bypassCode;
+        string $invalidMessage,
-        $this->humanity         = $humanity;
+        ?string $bypassCode,
+        int $humanity,
+        ?Request $req
+    ) {
+        $this->translator = $translator;
+        $this->session = $session;
+        $this->key = $key;
+        $this->invalidMessage = $invalidMessage;
+        $this->bypassCode = $bypassCode;
+        $this->humanity = $humanity;
+        $this->req = $req;
     }
 
-    /**
+    public function validate(FormEvent $event): void
-     * @param FormEvent $event
-     */
-    public function validate(FormEvent $event)
     {
-        $form = $form = $event->getForm();
+        $form = $event->getForm();
 
         $code = $form->getData();
         $expectedCode = $this->getExpectedCode();
@@ -75,12 +90,13 @@ class CaptchaValidator
         if ($this->humanity > 0) {
             $humanity = $this->getHumanity();
             if ($humanity > 0) {
-                $this->updateHumanity($humanity-1);
+                $this->updateHumanity($humanity - 1);
+
                 return;
             }
         }
 
-        if (!($code && is_string($code) && ($this->compare($code, $expectedCode) || $this->compare($code, $this->bypassCode)))) {
+        if (!(null !== $code && is_string($code) && ($this->compare($code, $expectedCode) || $this->compare($code, $this->bypassCode)))) {
             $form->addError(new FormError($this->translator->trans($this->invalidMessage, array(), 'validators')));
         } else {
             if ($this->humanity > 0) {
@@ -88,15 +104,16 @@ class CaptchaValidator
             }
         }
 
-        $this->session->remove($this->key);
+        if (null == $this->req || 1 < $this->req->get('flow_registration_step')) {
-
+            $this->session->remove($this->key);
-        if ($this->session->has($this->key . '_fingerprint')) {
+            if ($this->session->has($this->key.'_fingerprint')) {
-            $this->session->remove($this->key . '_fingerprint');
+                $this->session->remove($this->key.'_fingerprint');
+            }
         }
     }
 
     /**
-     * Retrieve the expected CAPTCHA code
+     * Retrieve the expected CAPTCHA code.
      *
      * @return mixed|null
      */
@@ -112,51 +129,39 @@ class CaptchaValidator
     }
 
     /**
-     * Retreive the humanity
+     * Retrieve the humanity.
      *
      * @return mixed|null
      */
     protected function getHumanity()
     {
-        return $this->session->get($this->key . '_humanity', 0);
+        return $this->session->get($this->key.'_humanity', 0);
     }
 
-    /**
+    protected function updateHumanity(int $newValue): void
-     * Updates the humanity
-     */
-    protected function updateHumanity($newValue)
     {
         if ($newValue > 0) {
-            $this->session->set($this->key . '_humanity', $newValue);
+            $this->session->set($this->key.'_humanity', $newValue);
         } else {
-            $this->session->remove($this->key . '_humanity');
+            $this->session->remove($this->key.'_humanity');
         }
-
-        return null;
     }
 
-    /**
+    protected function niceize(string $code): string
-     * Process the codes
-     *
-     * @param $code
-     *
-     * @return string
-     */
-    protected function niceize($code)
     {
         return strtr(strtolower($code), 'oil', '01l');
     }
 
     /**
-     * Run a match comparison on the provided code and the expected code
+     * Run a match comparison on the provided code and the expected code.
      *
-     * @param $code
+     * @param string      $code
-     * @param $expectedCode
+     * @param string|null $expectedCode
      *
      * @return bool
      */
-    protected function compare($code, $expectedCode)
+    protected function compare($code, $expectedCode): bool
     {
-        return ($expectedCode && is_string($expectedCode) && $this->niceize($code) == $this->niceize($expectedCode));
+        return null !== $expectedCode && is_string($expectedCode) && $this->niceize($code) == $this->niceize($expectedCode);
     }
 }

composer.json

@@ -1,9 +1,9 @@
 {
-    "name": "gregwar/captcha-bundle",
+    "name": "cadoles/captcha",
-    "type": "captcha-bundle",
+    "type": "symfony-bundle",
     "description": "Captcha bundle",
-    "keywords": ["symfony2", "captcha", "bot", "visual", "code", "security", "spam"],
+    "keywords": ["symfony2", "symfony", "captcha", "bot", "visual", "code", "security", "spam"],
-    "homepage": "https://github.com/Gregwar/CaptchaBundle",
+    "homepage": "https://github.com/Cadoles/CaptchaBundle",
     "license": "MIT",
     "authors": [
         {
@@ -17,13 +17,23 @@
         }
     ],
     "require": {
-        "php": ">=5.3.0",
+        "php": ">=7.1.3",
-        "gregwar/captcha": "v1.0.10"
+        "ext-gd": "*",
+        "gregwar/captcha": "^1.1.9",
+        "symfony/form": "~4.0|~5.0",
+        "symfony/framework-bundle": "~4.0|~5.0",
+        "symfony/translation": "~4.0|^5.0",
+        "twig/twig": "^2.10|^3.0"
     },
     "autoload": {
-        "psr-0": {
+        "psr-4": {
-            "Gregwar\\CaptchaBundle": ""
+            "Gregwar\\CaptchaBundle\\": "/"
         }
     },
-    "target-dir": "Gregwar/CaptchaBundle"
+    "config": {
+        "sort-packages": true
+    },
+    "require-dev": {
+        "symplify/easy-coding-standard": "^6.1"
+    }
 }

ecs.yaml

@@ -0,0 +1,138 @@
+parameters:
+  exclude_files:
+    - 'vendor/*'
+    - 'LICENSE'
+    - 'README.md'
+
+services:
+  # PSR1
+  PhpCsFixer\Fixer\Basic\EncodingFixer: ~
+  PhpCsFixer\Fixer\PhpTag\FullOpeningTagFixer: ~
+
+  PhpCsFixer\Fixer\NamespaceNotation\BlankLineAfterNamespaceFixer: ~
+  PhpCsFixer\Fixer\ControlStructure\ElseifFixer: ~
+  PhpCsFixer\Fixer\FunctionNotation\FunctionDeclarationFixer: ~
+  PhpCsFixer\Fixer\Whitespace\IndentationTypeFixer: ~
+  PhpCsFixer\Fixer\Whitespace\LineEndingFixer: ~
+  PhpCsFixer\Fixer\Casing\ConstantCaseFixer: ~
+  PhpCsFixer\Fixer\Casing\LowercaseKeywordsFixer: ~
+  PhpCsFixer\Fixer\FunctionNotation\MethodArgumentSpaceFixer:
+    ensure_fully_multiline: true
+  PhpCsFixer\Fixer\ControlStructure\NoBreakCommentFixer: ~
+  PhpCsFixer\Fixer\PhpTag\NoClosingTagFixer: ~
+  PhpCsFixer\Fixer\FunctionNotation\NoSpacesAfterFunctionNameFixer: ~
+  PhpCsFixer\Fixer\Whitespace\NoSpacesInsideParenthesisFixer: ~
+  PhpCsFixer\Fixer\Whitespace\NoTrailingWhitespaceFixer: ~
+  PhpCsFixer\Fixer\Comment\NoTrailingWhitespaceInCommentFixer: ~
+  PhpCsFixer\Fixer\Whitespace\SingleBlankLineAtEofFixer: ~
+  PhpCsFixer\Fixer\ClassNotation\SingleClassElementPerStatementFixer:
+    elements:
+      - 'property'
+  PhpCsFixer\Fixer\Import\SingleImportPerStatementFixer: ~
+  PhpCsFixer\Fixer\Import\SingleLineAfterImportsFixer: ~
+  PhpCsFixer\Fixer\ControlStructure\SwitchCaseSemicolonToColonFixer: ~
+  PhpCsFixer\Fixer\ControlStructure\SwitchCaseSpaceFixer: ~
+  PhpCsFixer\Fixer\ClassNotation\VisibilityRequiredFixer: ~
+
+  PhpCsFixer\Fixer\Basic\BracesFixer:
+    allow_single_line_closure: true
+  PhpCsFixer\Fixer\PhpTag\BlankLineAfterOpeningTagFixer: ~
+  PhpCsFixer\Fixer\Operator\ConcatSpaceFixer:
+    spacing: none
+  PhpCsFixer\Fixer\Operator\NewWithBracesFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\PhpdocAlignFixer:
+    tags:
+      - method
+      - param
+      - property
+      - return
+      - throws
+      - type
+      - var
+  PhpCsFixer\Fixer\Operator\BinaryOperatorSpacesFixer: ~
+  PhpCsFixer\Fixer\Operator\IncrementStyleFixer: ~
+  PhpCsFixer\Fixer\Operator\UnaryOperatorSpacesFixer: ~
+  PhpCsFixer\Fixer\Whitespace\BlankLineBeforeStatementFixer: ~
+  PhpCsFixer\Fixer\CastNotation\CastSpacesFixer: ~
+  PhpCsFixer\Fixer\LanguageConstruct\DeclareEqualNormalizeFixer: ~
+  PhpCsFixer\Fixer\FunctionNotation\FunctionTypehintSpaceFixer: ~
+  PhpCsFixer\Fixer\Comment\SingleLineCommentStyleFixer:
+    comment_types:
+      - hash
+  PhpCsFixer\Fixer\ControlStructure\IncludeFixer: ~
+  PhpCsFixer\Fixer\CastNotation\LowercaseCastFixer: ~
+  PhpCsFixer\Fixer\ClassNotation\ClassAttributesSeparationFixer:
+    elements:
+      - method
+  PhpCsFixer\Fixer\Casing\NativeFunctionCasingFixer: ~
+  PhpCsFixer\Fixer\ClassNotation\NoBlankLinesAfterClassOpeningFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\NoBlankLinesAfterPhpdocFixer: ~
+  PhpCsFixer\Fixer\Comment\NoEmptyCommentFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\NoEmptyPhpdocFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\PhpdocSeparationFixer: ~
+  PhpCsFixer\Fixer\Semicolon\NoEmptyStatementFixer: ~
+  PhpCsFixer\Fixer\Whitespace\NoExtraBlankLinesFixer:
+    tokens:
+      - curly_brace_block
+      - extra
+      - parenthesis_brace_block
+      - square_brace_block
+      - throw
+      - use
+  PhpCsFixer\Fixer\NamespaceNotation\NoLeadingNamespaceWhitespaceFixer: ~
+  PhpCsFixer\Fixer\ArrayNotation\NoMultilineWhitespaceAroundDoubleArrowFixer: ~
+  PhpCsFixer\Fixer\CastNotation\NoShortBoolCastFixer: ~
+  PhpCsFixer\Fixer\Semicolon\NoSinglelineWhitespaceBeforeSemicolonsFixer: ~
+  PhpCsFixer\Fixer\Whitespace\NoSpacesAroundOffsetFixer: ~
+  PhpCsFixer\Fixer\ControlStructure\NoTrailingCommaInListCallFixer: ~
+  PhpCsFixer\Fixer\ArrayNotation\NoTrailingCommaInSinglelineArrayFixer: ~
+  PhpCsFixer\Fixer\ArrayNotation\TrailingCommaInMultilineArrayFixer: ~
+  PhpCsFixer\Fixer\ControlStructure\NoUnneededControlParenthesesFixer: ~
+  PhpCsFixer\Fixer\ArrayNotation\NoWhitespaceBeforeCommaInArrayFixer: ~
+  PhpCsFixer\Fixer\Whitespace\NoWhitespaceInBlankLineFixer: ~
+  PhpCsFixer\Fixer\ArrayNotation\NormalizeIndexBraceFixer: ~
+  PhpCsFixer\Fixer\Operator\ObjectOperatorWithoutWhitespaceFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\PhpdocAnnotationWithoutDotFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\PhpdocIndentFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\PhpdocInlineTagFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\PhpdocNoAccessFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\PhpdocNoEmptyReturnFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\PhpdocNoPackageFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\PhpdocNoUselessInheritdocFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\PhpdocReturnSelfReferenceFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\PhpdocScalarFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\PhpdocSingleLineVarSpacingFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\PhpdocSummaryFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\PhpdocToCommentFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\PhpdocTrimFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\PhpdocTypesFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\PhpdocVarWithoutNameFixer: ~
+  PhpCsFixer\Fixer\FunctionNotation\ReturnTypeDeclarationFixer: ~
+  PhpCsFixer\Fixer\ClassNotation\SelfAccessorFixer: ~
+  PhpCsFixer\Fixer\CastNotation\ShortScalarCastFixer: ~
+  PhpCsFixer\Fixer\StringNotation\SingleQuoteFixer: ~
+  PhpCsFixer\Fixer\Semicolon\SpaceAfterSemicolonFixer: ~
+  PhpCsFixer\Fixer\Operator\StandardizeNotEqualsFixer: ~
+  PhpCsFixer\Fixer\Operator\TernaryOperatorSpacesFixer: ~
+  PhpCsFixer\Fixer\ArrayNotation\TrimArraySpacesFixer: ~
+  PhpCsFixer\Fixer\ArrayNotation\WhitespaceAfterCommaInArrayFixer: ~
+  PhpCsFixer\Fixer\ClassNotation\ClassDefinitionFixer:
+    singleLine: true
+  PhpCsFixer\Fixer\Casing\MagicConstantCasingFixer: ~
+  PhpCsFixer\Fixer\Alias\NoMixedEchoPrintFixer:
+    use: echo
+  PhpCsFixer\Fixer\Import\NoLeadingImportSlashFixer: ~
+  PhpCsFixer\Fixer\Import\NoUnusedImportsFixer: ~
+  PhpCsFixer\Fixer\PhpUnit\PhpUnitFqcnAnnotationFixer: ~
+  PhpCsFixer\Fixer\Phpdoc\PhpdocNoAliasTagFixer: ~
+  PhpCsFixer\Fixer\ClassNotation\ProtectedToPrivateFixer: ~
+  PhpCsFixer\Fixer\NamespaceNotation\SingleBlankLineBeforeNamespaceFixer: ~
+
+  # new since PHP-CS-Fixer 2.6
+  PhpCsFixer\Fixer\ControlStructure\NoUnneededCurlyBracesFixer: ~
+  PhpCsFixer\Fixer\ClassNotation\NoUnneededFinalMethodFixer: ~
+  PhpCsFixer\Fixer\Semicolon\SemicolonAfterInstructionFixer: ~
+  PhpCsFixer\Fixer\ControlStructure\YodaStyleFixer: ~
+
+  # new since 2.11
+  PhpCsFixer\Fixer\Operator\StandardizeIncrementFixer: ~