Compare commits
No commits in common. "master" and "v2.0.7" have entirely different histories.
|
@ -1,37 +1,32 @@
|
|||
<?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\Component\HttpKernel\Exception\NotFoundHttpException;
|
||||
|
||||
/**
|
||||
* Generates a captcha via a URL.
|
||||
* Generates a captcha via a URL
|
||||
*
|
||||
* @author Jeremy Livingston <jeremy.j.livingston@gmail.com>
|
||||
*/
|
||||
class CaptchaController extends AbstractController
|
||||
{
|
||||
/** @var CaptchaGenerator */
|
||||
private $captchaGenerator;
|
||||
|
||||
/** @var array */
|
||||
private $config;
|
||||
|
||||
public function __construct(CaptchaGenerator $captchaGenerator, array $config)
|
||||
/**
|
||||
* Action that is used to generate the captcha, save its code, and stream the image
|
||||
*
|
||||
* @param string $key
|
||||
*
|
||||
* @return Response
|
||||
*
|
||||
* @throws NotFoundHttpException
|
||||
*/
|
||||
public function generateCaptchaAction($key)
|
||||
{
|
||||
$this->captchaGenerator = $captchaGenerator;
|
||||
$this->config = $config;
|
||||
}
|
||||
|
||||
public function generateCaptchaAction(Request $request, string $key): Response
|
||||
{
|
||||
$session = $request->getSession();
|
||||
$whitelistKey = $this->config['whitelist_key'];
|
||||
$options = $this->container->getParameter('gregwar_captcha.config');
|
||||
$session = $this->get('session');
|
||||
$whitelistKey = $options['whitelist_key'];
|
||||
$isOk = false;
|
||||
|
||||
if ($session->has($whitelistKey)) {
|
||||
|
@ -42,18 +37,21 @@ class CaptchaController extends AbstractController
|
|||
}
|
||||
|
||||
if (!$isOk) {
|
||||
return $this->error($this->config);
|
||||
return $this->error($options);
|
||||
}
|
||||
|
||||
$persistedOptions = $session->get($key, array());
|
||||
$options = array_merge($this->config, $persistedOptions);
|
||||
/* @var \Gregwar\CaptchaBundle\Generator\CaptchaGenerator $generator */
|
||||
$generator = $this->container->get('gregwar_captcha.generator');
|
||||
|
||||
$phrase = $this->captchaGenerator->getPhrase($options);
|
||||
$this->captchaGenerator->setPhrase($phrase);
|
||||
$persistedOptions = $session->get($key, array());
|
||||
$options = array_merge($options, $persistedOptions);
|
||||
|
||||
$phrase = $generator->getPhrase($options);
|
||||
$generator->setPhrase($phrase);
|
||||
$persistedOptions['phrase'] = $phrase;
|
||||
$session->set($key, $persistedOptions);
|
||||
|
||||
$response = new Response($this->captchaGenerator->generate($options));
|
||||
$response = new Response($generator->generate($options));
|
||||
$response->headers->set('Content-type', 'image/jpeg');
|
||||
$response->headers->set('Pragma', 'no-cache');
|
||||
$response->headers->set('Cache-Control', 'no-cache');
|
||||
|
@ -61,11 +59,20 @@ class CaptchaController extends AbstractController
|
|||
return $response;
|
||||
}
|
||||
|
||||
private function error(array $options): Response
|
||||
/**
|
||||
* Returns an empty image with status code 428 Precondition Required
|
||||
*
|
||||
* @param array $options
|
||||
*
|
||||
* @return Response
|
||||
*/
|
||||
protected function error($options)
|
||||
{
|
||||
$this->captchaGenerator->setPhrase('');
|
||||
/* @var \Gregwar\CaptchaBundle\Generator\CaptchaGenerator $generator */
|
||||
$generator = $this->container->get('gregwar_captcha.generator');
|
||||
$generator->setPhrase('');
|
||||
|
||||
$response = new Response($this->captchaGenerator->generate($options));
|
||||
$response = new Response($generator->generate($options));
|
||||
$response->setStatusCode(428);
|
||||
$response->headers->set('Content-type', 'image/jpeg');
|
||||
$response->headers->set('Pragma', 'no-cache');
|
||||
|
|
|
@ -1,7 +1,5 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Gregwar\CaptchaBundle\DependencyInjection;
|
||||
|
||||
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
|
||||
|
@ -9,10 +7,21 @@ 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('gregwar_captcha');
|
||||
$rootNode = $treeBuilder->getRootNode();
|
||||
|
||||
if (method_exists($treeBuilder, 'getRootNode')) {
|
||||
$rootNode = $treeBuilder->getRootNode();
|
||||
} else {
|
||||
// BC for symfony/config <= 4.1
|
||||
$rootNode = $treeBuilder->root('gregwar_captcha');
|
||||
}
|
||||
|
||||
$rootNode
|
||||
->addDefaultsIfNotSet()
|
||||
|
@ -27,7 +36,7 @@ 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.project_dir%/public')->end()
|
||||
->scalarNode('web_path')->defaultValue('%kernel.root_dir%/../web')->end()
|
||||
->scalarNode('gc_freq')->defaultValue(100)->end()
|
||||
->scalarNode('expiration')->defaultValue(60)->end()
|
||||
->scalarNode('quality')->defaultValue(50)->end()
|
||||
|
|
|
@ -1,29 +1,24 @@
|
|||
<?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 ContainerBuilder $container
|
||||
*
|
||||
* @throws Exception
|
||||
*/
|
||||
public function load(array $configs, ContainerBuilder $container): void
|
||||
public function load(array $configs, ContainerBuilder $container)
|
||||
{
|
||||
$loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
|
||||
$loader->load('services.yml');
|
||||
|
|
|
@ -1,40 +1,48 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Gregwar\CaptchaBundle\Generator;
|
||||
|
||||
use Gregwar\Captcha\CaptchaBuilder;
|
||||
use Gregwar\Captcha\PhraseBuilder;
|
||||
use Symfony\Component\HttpFoundation\Session\SessionInterface;
|
||||
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 RouterInterface
|
||||
*/
|
||||
protected $router;
|
||||
|
||||
/** @var CaptchaBuilder */
|
||||
/**
|
||||
* @var CaptchaBuilder
|
||||
*/
|
||||
protected $builder;
|
||||
|
||||
/** @var PhraseBuilder */
|
||||
/**
|
||||
* @var PhraseBuilder
|
||||
*/
|
||||
protected $phraseBuilder;
|
||||
|
||||
/** @var ImageFileHandler */
|
||||
/**
|
||||
* @var ImageFileHandler
|
||||
*/
|
||||
protected $imageFileHandler;
|
||||
|
||||
/**
|
||||
* @param RouterInterface $router
|
||||
* @param RouterInterface $router
|
||||
* @param CaptchaBuilderInterface $builder
|
||||
* @param PhraseBuilderInterface $phraseBuilder
|
||||
* @param ImageFileHandler $imageFileHandler
|
||||
* @param PhraseBuilderInterface $phraseBuilder
|
||||
* @param ImageFileHandler $imageFileHandler
|
||||
*/
|
||||
public function __construct(
|
||||
RouterInterface $router,
|
||||
|
@ -42,13 +50,20 @@ class CaptchaGenerator
|
|||
PhraseBuilderInterface $phraseBuilder,
|
||||
ImageFileHandler $imageFileHandler
|
||||
) {
|
||||
$this->router = $router;
|
||||
$this->builder = $builder;
|
||||
$this->phraseBuilder = $phraseBuilder;
|
||||
$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 array $options
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getCaptchaCode(array &$options)
|
||||
{
|
||||
$this->builder->setPhrase($this->getPhrase($options));
|
||||
|
||||
|
@ -61,21 +76,27 @@ class CaptchaGenerator
|
|||
|
||||
// Returns the image generation URL
|
||||
if ($options['as_url']) {
|
||||
return $this->router->generate(
|
||||
'gregwar_captcha.generate_captcha',
|
||||
array('key' => $options['session_key'], 'n' => md5(microtime(true).mt_rand()))
|
||||
);
|
||||
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 array $options
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function generate(array &$options)
|
||||
{
|
||||
$this->builder->setDistortion($options['distortion']);
|
||||
|
||||
|
@ -83,7 +104,7 @@ class CaptchaGenerator
|
|||
$this->builder->setMaxBehindLines($options['max_behind_lines']);
|
||||
|
||||
if (isset($options['text_color']) && $options['text_color']) {
|
||||
if (3 !== count($options['text_color'])) {
|
||||
if (count($options['text_color']) !== 3) {
|
||||
throw new \RuntimeException('text_color should be an array of r, g and b');
|
||||
}
|
||||
|
||||
|
@ -92,7 +113,7 @@ class CaptchaGenerator
|
|||
}
|
||||
|
||||
if (isset($options['background_color']) && $options['background_color']) {
|
||||
if (3 !== count($options['background_color'])) {
|
||||
if (count($options['background_color']) !== 3) {
|
||||
throw new \RuntimeException('background_color should be an array of r, g and b');
|
||||
}
|
||||
|
||||
|
@ -128,7 +149,12 @@ class CaptchaGenerator
|
|||
return $this->imageFileHandler->saveAsFile($content);
|
||||
}
|
||||
|
||||
public function getPhrase(array &$options): string
|
||||
/**
|
||||
* @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'])) {
|
||||
|
@ -137,7 +163,7 @@ class CaptchaGenerator
|
|||
$phrase = $this->phraseBuilder->build($options['length'], $options['charset']);
|
||||
$options['phrase'] = $phrase;
|
||||
}
|
||||
|
||||
|
||||
return $phrase;
|
||||
}
|
||||
}
|
||||
|
|
|
@ -1,13 +1,11 @@
|
|||
<?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>
|
||||
|
@ -15,61 +13,69 @@ 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 string $imageFolder
|
||||
* @param string $webPath
|
||||
* @param string $gcFreq
|
||||
* @param string $expiration
|
||||
* @param $imageFolder
|
||||
* @param $webPath
|
||||
* @param $gcFreq
|
||||
* @param $expiration
|
||||
*/
|
||||
public function __construct(string $imageFolder, string $webPath, string $gcFreq, string $expiration)
|
||||
public function __construct($imageFolder, $webPath, $gcFreq, $expiration)
|
||||
{
|
||||
$this->imageFolder = $imageFolder;
|
||||
$this->webPath = $webPath;
|
||||
$this->gcFreq = $gcFreq;
|
||||
$this->expiration = $expiration;
|
||||
$this->imageFolder = $imageFolder;
|
||||
$this->webPath = $webPath;
|
||||
$this->gcFreq = $gcFreq;
|
||||
$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';
|
||||
$filePath = $this->webPath.'/'.$this->imageFolder.'/'.$filename;
|
||||
$filename = md5(uniqid()) . '.jpg';
|
||||
$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 (1 == !mt_rand(1, $this->gcFreq)) {
|
||||
if (!mt_rand(1, $this->gcFreq) == 1) {
|
||||
return false;
|
||||
}
|
||||
|
||||
|
@ -77,20 +83,23 @@ 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)) {
|
||||
mkdir($this->webPath.'/'.$this->imageFolder, 0755);
|
||||
if (!file_exists($this->webPath . '/' . $this->imageFolder)) {
|
||||
mkdir($this->webPath . '/' . $this->imageFolder, 0755);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
@ -1,7 +1,5 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Gregwar\CaptchaBundle;
|
||||
|
||||
use Symfony\Component\HttpKernel\Bundle\Bundle;
|
||||
|
|
149
README.md
149
README.md
|
@ -11,56 +11,107 @@ It uses [gregwar/captcha](https://github.com/Gregwar/Captcha) as captcha generat
|
|||
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 |
|
||||
If you are using Symfony `< 2.8`, you should use version `1.*`
|
||||
|
||||
If you are using SYmfony `>= 2.8`, you should use version `2.*`
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
### Step 1: Download the GregwarCaptchaBundle
|
||||
|
||||
Use composer require to download and install the package.
|
||||
At the end of the installation, the bundle is automatically registered thanks to the Symfony recipe.
|
||||
Ultimately, the GregwarCaptchaBundle files should be downloaded to the
|
||||
'vendor/bundles/Gregwar/CaptchaBundle' directory.
|
||||
|
||||
You can accomplish this several ways, depending on your personal preference.
|
||||
The first method is the standard Symfony method.
|
||||
|
||||
***Using Composer***
|
||||
|
||||
Use composer require to download and install the package.
|
||||
|
||||
``` bash
|
||||
composer require gregwar/captcha-bundle
|
||||
```
|
||||
|
||||
If you don't use flex, register it manually:
|
||||
***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
|
||||
```
|
||||
|
||||
***Using submodules***
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
### 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
|
||||
// config/bundles.php
|
||||
return [
|
||||
// ...
|
||||
Gregwar\CaptchaBundle\GregwarCaptchaBundle::class => ['all' => true]
|
||||
];
|
||||
// app/appKernel.php
|
||||
|
||||
public function registerBundles()
|
||||
{
|
||||
$bundles = array(
|
||||
// ...
|
||||
new Gregwar\CaptchaBundle\GregwarCaptchaBundle(),
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
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:
|
||||
width: 160
|
||||
height: 50
|
||||
```
|
||||
Add the following configuration to your `app/config/config.yml`:
|
||||
|
||||
gregwar_captcha: ~
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
You can use the "captcha" type in your forms this way:
|
||||
|
||||
``` php
|
||||
```php
|
||||
<?php
|
||||
use Gregwar\CaptchaBundle\Type\CaptchaType;
|
||||
// ...
|
||||
$builder->add('captcha', CaptchaType::class); // That's all !
|
||||
// ...
|
||||
use Gregwar\CaptchaBundle\Type\CaptchaType;
|
||||
// ...
|
||||
$builder->add('captcha', CaptchaType::class); // That's all !
|
||||
// If you're using php<5.5, you can use instead:
|
||||
$builder->add('captcha', 'Gregwar\CaptchaBundle\Type\CaptchaType');
|
||||
// ...
|
||||
```
|
||||
|
||||
Note that the generated image will, by default, be embedded in the HTML document
|
||||
|
@ -72,7 +123,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.project_dir%/public')
|
||||
* **web_path**: absolute path to public web folder (default="%kernel.root_dir%/../web")
|
||||
* **gc_freq**: frequency of garbage collection in fractions of 1 (default=100)
|
||||
* **expiration**: maximum lifetime of captcha image files in minutes (default=60)
|
||||
|
||||
|
@ -101,29 +152,27 @@ number of lines depends on the size of the image). (default=null)
|
|||
* **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', CaptchaType::class, array(
|
||||
'width' => 200,
|
||||
'height' => 50,
|
||||
'length' => 6,
|
||||
));
|
||||
use Gregwar\CaptchaBundle\Type\CaptchaType;
|
||||
// ...
|
||||
$builder->add('captcha', CaptchaType::class, array(
|
||||
'width' => 200,
|
||||
'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:
|
||||
width: 200
|
||||
height: 50
|
||||
length: 6
|
||||
```
|
||||
|
||||
gregwar_captcha:
|
||||
width: 200
|
||||
height: 50
|
||||
length: 6
|
||||
|
||||
Translation
|
||||
===========
|
||||
|
@ -132,20 +181,16 @@ 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 `config/routes.yaml` file:
|
||||
To use a URL to generate a captcha image, you must add the bundle's routing configuration to your app/routing.yml file:
|
||||
|
||||
``` yaml
|
||||
gregwar_captcha_routing:
|
||||
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:
|
||||
|
||||
``` yaml
|
||||
gregwar_captcha_routing:
|
||||
resource: "@GregwarCaptchaBundle/Resources/config/routing/routing.yml"
|
||||
prefix: /_gcb
|
||||
```
|
||||
gregwar_captcha_routing:
|
||||
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
|
||||
|
||||
|
@ -156,7 +201,7 @@ The widget support the standard Symfony theming, see the [documentation](http://
|
|||
|
||||
The default rendering is:
|
||||
|
||||
``` twig
|
||||
```html
|
||||
{% block captcha_widget %}
|
||||
{% spaceless %}
|
||||
<img src="{{ captcha_code }}" title="captcha" width="{{ captcha_width }}" height="{{ captcha_height }}" />
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
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
|
||||
|
@ -7,20 +6,7 @@ parameters:
|
|||
gregwar_captcha.phrase_builder.class: Gregwar\Captcha\PhraseBuilder
|
||||
|
||||
services:
|
||||
Gregwar\CaptchaBundle\Controller\CaptchaController:
|
||||
public: true
|
||||
alias: 'gregwar_captcha.controller'
|
||||
|
||||
gregwar_captcha.controller:
|
||||
class: '%gregwar_captcha.controller.class%'
|
||||
public: true
|
||||
arguments:
|
||||
- '@gregwar_captcha.generator'
|
||||
- '%gregwar_captcha.config%'
|
||||
autowire: true
|
||||
|
||||
# captcha.type:
|
||||
gregwar_captcha.type:
|
||||
captcha.type:
|
||||
class: '%gregwar_captcha.captcha_type.class%'
|
||||
public: true
|
||||
arguments:
|
||||
|
|
|
@ -1,23 +1,22 @@
|
|||
<?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\OptionsResolver;
|
||||
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
|
||||
use Symfony\Component\Form\FormEvents;
|
||||
use Symfony\Contracts\Translation\TranslatorInterface;
|
||||
use Symfony\Component\Translation\TranslatorInterface;
|
||||
|
||||
use Gregwar\CaptchaBundle\Validator\CaptchaValidator;
|
||||
use Gregwar\CaptchaBundle\Generator\CaptchaGenerator;
|
||||
|
||||
/**
|
||||
* Captcha type.
|
||||
* Captcha type
|
||||
*
|
||||
* @author Gregwar <g.passault@gmail.com>
|
||||
*/
|
||||
|
@ -25,16 +24,25 @@ class CaptchaType extends AbstractType
|
|||
{
|
||||
const SESSION_KEY_PREFIX = '_captcha_';
|
||||
|
||||
/** @var SessionInterface */
|
||||
/**
|
||||
* @var SessionInterface
|
||||
*/
|
||||
protected $session;
|
||||
|
||||
/** @var CaptchaGenerator */
|
||||
/**
|
||||
* @var CaptchaGenerator
|
||||
*/
|
||||
protected $generator;
|
||||
|
||||
/** @var TranslatorInterface */
|
||||
/**
|
||||
* @var TranslatorInterface
|
||||
*/
|
||||
protected $translator;
|
||||
|
||||
/** @var array */
|
||||
/**
|
||||
* Options
|
||||
* @var array
|
||||
*/
|
||||
private $options = array();
|
||||
|
||||
/**
|
||||
|
@ -45,10 +53,10 @@ class CaptchaType extends AbstractType
|
|||
*/
|
||||
public function __construct(SessionInterface $session, CaptchaGenerator $generator, TranslatorInterface $translator, $options)
|
||||
{
|
||||
$this->session = $session;
|
||||
$this->generator = $generator;
|
||||
$this->translator = $translator;
|
||||
$this->options = $options;
|
||||
$this->session = $session;
|
||||
$this->generator = $generator;
|
||||
$this->translator = $translator;
|
||||
$this->options = $options;
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -62,11 +70,10 @@ class CaptchaType extends AbstractType
|
|||
sprintf('%s%s', self::SESSION_KEY_PREFIX, $options['session_key']),
|
||||
$options['invalid_message'],
|
||||
$options['bypass_code'],
|
||||
$options['humanity'],
|
||||
$options['request']
|
||||
$options['humanity']
|
||||
);
|
||||
|
||||
$builder->addEventListener(FormEvents::POST_SUBMIT, array($validator, 'validate'));
|
||||
$event = \Symfony\Component\HttpKernel\Kernel::VERSION >= 2.3 ? FormEvents::POST_SUBMIT : FormEvents::POST_BIND;
|
||||
$builder->addEventListener($event, array($validator, 'validate'));
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -79,7 +86,7 @@ class CaptchaType extends AbstractType
|
|||
}
|
||||
|
||||
$sessionKey = sprintf('%s%s', self::SESSION_KEY_PREFIX, $options['session_key']);
|
||||
$isHuman = false;
|
||||
$isHuman = false;
|
||||
|
||||
if ($options['humanity'] > 0) {
|
||||
$humanityKey = sprintf('%s_humanity', $sessionKey);
|
||||
|
@ -98,18 +105,18 @@ class CaptchaType extends AbstractType
|
|||
}
|
||||
|
||||
$view->vars = array_merge($view->vars, array(
|
||||
'captcha_width' => $options['width'],
|
||||
'captcha_height' => $options['height'],
|
||||
'reload' => $options['reload'],
|
||||
'image_id' => uniqid('captcha_'),
|
||||
'captcha_code' => $this->generator->getCaptchaCode($options),
|
||||
'value' => '',
|
||||
'is_human' => $isHuman,
|
||||
'captcha_width' => $options['width'],
|
||||
'captcha_height' => $options['height'],
|
||||
'reload' => $options['reload'],
|
||||
'image_id' => uniqid('captcha_'),
|
||||
'captcha_code' => $this->generator->getCaptchaCode($options),
|
||||
'value' => '',
|
||||
'is_human' => $isHuman
|
||||
));
|
||||
|
||||
$persistOptions = array();
|
||||
foreach (array('phrase', 'width', 'height', 'distortion', 'length',
|
||||
'quality', 'background_color', 'background_images', 'text_color', ) as $key) {
|
||||
'quality', 'background_color', 'background_images', 'text_color') as $key) {
|
||||
$persistOptions[$key] = $options[$key];
|
||||
}
|
||||
|
||||
|
@ -122,21 +129,39 @@ class CaptchaType extends AbstractType
|
|||
public function configureOptions(OptionsResolver $resolver)
|
||||
{
|
||||
$this->options['mapped'] = false;
|
||||
$this->options['request'] = null;
|
||||
$resolver->setDefaults($this->options);
|
||||
}
|
||||
|
||||
public function getParent(): string
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
* BC for SF < 2.7
|
||||
*/
|
||||
public function setDefaultOptions(OptionsResolverInterface $resolver)
|
||||
{
|
||||
return TextType::class;
|
||||
$this->configureOptions($resolver);
|
||||
}
|
||||
|
||||
public function getName(): string
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getParent()
|
||||
{
|
||||
// Not using ::class to support Symfony 2.8 w/ php>=5.3.9
|
||||
return 'Symfony\Component\Form\Extension\Core\Type\TextType';
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getName()
|
||||
{
|
||||
return $this->getBlockPrefix();
|
||||
}
|
||||
|
||||
public function getBlockPrefix(): string
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getBlockPrefix()
|
||||
{
|
||||
return 'captcha';
|
||||
}
|
||||
|
|
|
@ -1,86 +1,73 @@
|
|||
<?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\Contracts\Translation\TranslatorInterface;
|
||||
use Symfony\Component\HttpFoundation\Request;
|
||||
use Symfony\Component\Translation\TranslatorInterface;
|
||||
|
||||
/**
|
||||
* Captcha validator.
|
||||
* Captcha validator
|
||||
*
|
||||
* @author Gregwar <g.passault@gmail.com>
|
||||
*/
|
||||
class CaptchaValidator
|
||||
{
|
||||
/** @var SessionInterface */
|
||||
/**
|
||||
* @var SessionInterface
|
||||
*/
|
||||
private $session;
|
||||
|
||||
/**
|
||||
* Session key to store the code.
|
||||
*
|
||||
* @var string
|
||||
* Session key to store the code
|
||||
*/
|
||||
private $key;
|
||||
|
||||
/**
|
||||
* Error message text for non-matching submissions.
|
||||
*
|
||||
* @var string
|
||||
* Error message text for non-matching submissions
|
||||
*/
|
||||
private $invalidMessage;
|
||||
|
||||
/**
|
||||
* Configuration parameter used to bypass a required code match.
|
||||
*
|
||||
* @var string
|
||||
* Configuration parameter used to bypass a required code match
|
||||
*/
|
||||
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;
|
||||
|
||||
/**
|
||||
* Request
|
||||
*
|
||||
* @var Request
|
||||
* @param TranslatorInterface $translator
|
||||
* @param SessionInterface $session
|
||||
* @param string $key
|
||||
* @param string $invalidMessage
|
||||
* @param string $bypassCode
|
||||
* @param int $humanity
|
||||
*/
|
||||
private $req;
|
||||
|
||||
public function __construct(
|
||||
TranslatorInterface $translator,
|
||||
SessionInterface $session,
|
||||
string $key,
|
||||
string $invalidMessage,
|
||||
?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 __construct(TranslatorInterface $translator, SessionInterface $session, $key, $invalidMessage, $bypassCode, $humanity)
|
||||
{
|
||||
$this->translator = $translator;
|
||||
$this->session = $session;
|
||||
$this->key = $key;
|
||||
$this->invalidMessage = $invalidMessage;
|
||||
$this->bypassCode = (string)$bypassCode;
|
||||
$this->humanity = $humanity;
|
||||
}
|
||||
|
||||
public function validate(FormEvent $event): void
|
||||
/**
|
||||
* @param FormEvent $event
|
||||
*/
|
||||
public function validate(FormEvent $event)
|
||||
{
|
||||
$form = $event->getForm();
|
||||
|
||||
|
@ -90,13 +77,12 @@ class CaptchaValidator
|
|||
if ($this->humanity > 0) {
|
||||
$humanity = $this->getHumanity();
|
||||
if ($humanity > 0) {
|
||||
$this->updateHumanity($humanity - 1);
|
||||
|
||||
$this->updateHumanity($humanity-1);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
if (!(null !== $code && is_string($code) && ($this->compare($code, $expectedCode) || $this->compare($code, $this->bypassCode)))) {
|
||||
if (!($code !== null && 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) {
|
||||
|
@ -104,16 +90,15 @@ class CaptchaValidator
|
|||
}
|
||||
}
|
||||
|
||||
if (null == $this->req || 1 < $this->req->get('flow_registration_step')) {
|
||||
$this->session->remove($this->key);
|
||||
if ($this->session->has($this->key.'_fingerprint')) {
|
||||
$this->session->remove($this->key.'_fingerprint');
|
||||
}
|
||||
$this->session->remove($this->key);
|
||||
|
||||
if ($this->session->has($this->key . '_fingerprint')) {
|
||||
$this->session->remove($this->key . '_fingerprint');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the expected CAPTCHA code.
|
||||
* Retrieve the expected CAPTCHA code
|
||||
*
|
||||
* @return mixed|null
|
||||
*/
|
||||
|
@ -129,39 +114,51 @@ class CaptchaValidator
|
|||
}
|
||||
|
||||
/**
|
||||
* Retrieve 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 string $code
|
||||
* @param string|null $expectedCode
|
||||
* @param $code
|
||||
* @param $expectedCode
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
protected function compare($code, $expectedCode): bool
|
||||
protected function compare($code, $expectedCode)
|
||||
{
|
||||
return null !== $expectedCode && is_string($expectedCode) && $this->niceize($code) == $this->niceize($expectedCode);
|
||||
return ($expectedCode !== null && is_string($expectedCode) && $this->niceize($code) == $this->niceize($expectedCode));
|
||||
}
|
||||
}
|
||||
|
|
|
@ -1,9 +1,9 @@
|
|||
{
|
||||
"name": "cadoles/captcha",
|
||||
"type": "symfony-bundle",
|
||||
"name": "gregwar/captcha-bundle",
|
||||
"type": "captcha-bundle",
|
||||
"description": "Captcha bundle",
|
||||
"keywords": ["symfony2", "symfony", "captcha", "bot", "visual", "code", "security", "spam"],
|
||||
"homepage": "https://github.com/Cadoles/CaptchaBundle",
|
||||
"keywords": ["symfony2", "captcha", "bot", "visual", "code", "security", "spam"],
|
||||
"homepage": "https://github.com/Gregwar/CaptchaBundle",
|
||||
"license": "MIT",
|
||||
"authors": [
|
||||
{
|
||||
|
@ -17,23 +17,15 @@
|
|||
}
|
||||
],
|
||||
"require": {
|
||||
"php": ">=7.1.3",
|
||||
"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"
|
||||
"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",
|
||||
"twig/twig": "^1.40|^2.9"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Gregwar\\CaptchaBundle\\": "/"
|
||||
}
|
||||
},
|
||||
"config": {
|
||||
"sort-packages": true
|
||||
},
|
||||
"require-dev": {
|
||||
"symplify/easy-coding-standard": "^6.1"
|
||||
}
|
||||
}
|
||||
|
|
138
ecs.yaml
138
ecs.yaml
|
@ -1,138 +0,0 @@
|
|||
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: ~
|
Loading…
Reference in New Issue