PHP code example of pedrotroller / php-cs-custom-fixer
1. Go to this page and download the library: Download pedrotroller/php-cs-custom-fixer library. Choose the download type require. 2. Extract the ZIP file and open the index.php. 3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
pedrotroller / php-cs-custom-fixer example snippets
// .php_cs.dist
$config = PhpCsFixer\Config::create()
// ...
->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers())
// ...
;
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
[
// ...
'PedroTroller/order_behat_steps' => true,
// ...
]
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
PedroTroller\CS\Fixer\RuleSetFactory::create()
->enable('PedroTroller/order_behat_steps')
->getRules()
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
[
// ...
'PedroTroller/order_behat_steps' => [ 'instanceof' => [ 'Behat\Behat\Context\Context' ] ],
// ...
]
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
PedroTroller\CS\Fixer\RuleSetFactory::create()
->enable('PedroTroller/order_behat_steps', [ 'instanceof' => [ 'Behat\Behat\Context\Context' ] ])
->getRules()
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
[
// ...
'PedroTroller/ordered_with_getter_and_setter_first' => true,
// ...
]
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
PedroTroller\CS\Fixer\RuleSetFactory::create()
->enable('PedroTroller/ordered_with_getter_and_setter_first')
->getRules()
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
[
// ...
'PedroTroller/exceptions_punctuation' => true,
// ...
]
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
PedroTroller\CS\Fixer\RuleSetFactory::create()
->enable('PedroTroller/exceptions_punctuation')
->getRules()
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
[
// ...
'PedroTroller/forbidden_functions' => [ 'comment' => 'YOLO' ],
// ...
]
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
PedroTroller\CS\Fixer\RuleSetFactory::create()
->enable('PedroTroller/forbidden_functions', [ 'comment' => 'YOLO' ])
->getRules()
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
[
// ...
'PedroTroller/forbidden_functions' => [ 'comment' => 'NEIN NEIN NEIN !!!', 'functions' => [ 'var_dump', 'var_export' ] ],
// ...
]
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
PedroTroller\CS\Fixer\RuleSetFactory::create()
->enable('PedroTroller/forbidden_functions', [ 'comment' => 'NEIN NEIN NEIN !!!', 'functions' => [ 'var_dump', 'var_export' ] ])
->getRules()
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
[
// ...
'PedroTroller/line_break_between_method_arguments' => [ 'max-args' => 4, 'max-length' => 120, 'automatic-argument-merge' => true, 'inline-attributes' => true ],
// ...
]
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
PedroTroller\CS\Fixer\RuleSetFactory::create()
->enable('PedroTroller/line_break_between_method_arguments', [ 'max-args' => 4, 'max-length' => 120, 'automatic-argument-merge' => true, 'inline-attributes' => true ])
->getRules()
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
[
// ...
'PedroTroller/line_break_between_method_arguments' => [ 'max-args' => false, 'max-length' => 120, 'automatic-argument-merge' => true, 'inline-attributes' => true ],
// ...
]
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
PedroTroller\CS\Fixer\RuleSetFactory::create()
->enable('PedroTroller/line_break_between_method_arguments', [ 'max-args' => false, 'max-length' => 120, 'automatic-argument-merge' => true, 'inline-attributes' => true ])
->getRules()
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
[
// ...
'PedroTroller/line_break_between_statements' => true,
// ...
]
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
PedroTroller\CS\Fixer\RuleSetFactory::create()
->enable('PedroTroller/line_break_between_statements')
->getRules()
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
[
// ...
'PedroTroller/comment_line_to_phpdoc_block' => true,
// ...
]
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
PedroTroller\CS\Fixer\RuleSetFactory::create()
->enable('PedroTroller/comment_line_to_phpdoc_block')
->getRules()
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
[
// ...
'PedroTroller/useless_code_after_return' => true,
// ...
]
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
PedroTroller\CS\Fixer\RuleSetFactory::create()
->enable('PedroTroller/useless_code_after_return')
->getRules()
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
[
// ...
'PedroTroller/doctrine_migrations' => true,
// ...
]
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
PedroTroller\CS\Fixer\RuleSetFactory::create()
->enable('PedroTroller/doctrine_migrations')
->getRules()
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
[
// ...
'PedroTroller/doctrine_migrations' => [ 'instanceof' => [ 'Doctrine\Migrations\AbstractMigration' ] ],
// ...
]
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
PedroTroller\CS\Fixer\RuleSetFactory::create()
->enable('PedroTroller/doctrine_migrations', [ 'instanceof' => [ 'Doctrine\Migrations\AbstractMigration' ] ])
->getRules()
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
[
// ...
'PedroTroller/phpspec' => true,
// ...
]
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
PedroTroller\CS\Fixer\RuleSetFactory::create()
->enable('PedroTroller/phpspec')
->getRules()
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
[
// ...
'PedroTroller/phpspec' => [ 'instanceof' => [ 'PhpSpec\ObjectBehavior' ] ],
// ...
]
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
// .php_cs.dist
$config = new PhpCsFixer\Config();
// ...
$config->setRules(
PedroTroller\CS\Fixer\RuleSetFactory::create()
->enable('PedroTroller/phpspec', [ 'instanceof' => [ 'PhpSpec\ObjectBehavior' ] ])
->getRules()
);
$config->registerCustomFixers(new PedroTroller\CS\Fixer\Fixers());
// ...
return $config;
diff
--- Original // 80 chars
+++ New //
@@ @@ //
} //
} //
//
- public function setFirstName($firstName) //
+ public function getIdentifier() //
{ //
- $this->firstName = $firstName; //
+ return $this->identifier; //
} //
//
- public function setName($name) //
+ public function getName() //
{ //
- $this->name = $name; //
+ return $this->name; //
} //
//
- public function isEnabled() //
+ public function setName($name) //
{ //
- return $this->enabled; //
+ $this->name = $name; //
} //
//
- public function getName() //
+ public function getFirstName() //
{ //
- return $this->name; //
+ return $this->firstName; //
} //
//
- public function getIdentifier() //
+ public function setFirstName($firstName) //
{ //
- return $this->identifier; //
+ $this->firstName = $firstName; //
} //
//
- public function getFirstName() //
+ public function isEnabled() //
{ //
- return $this->firstName; //
+ return $this->enabled; //
} //
//
public function enable() //
//
diff
--- Original // 80 chars
+++ New //
@@ @@ //
class MyClass { //
public function fun() //
{ //
- var_dump('this is a var_dump'); //
+ var_dump('this is a var_dump'); // YOLO //
//
$this->dump($this); //
//
//
diff
--- Original // 80 chars
+++ New //
@@ @@ //
class MyClass { //
public function fun() //
{ //
- var_dump('this is a var_dump'); //
+ var_dump('this is a var_dump'); // NEIN NEIN NEIN !!! //
//
$this->dump($this); //
//
- return var_export($this); //
+ return var_export($this); // NEIN NEIN NEIN !!! //
} //
//
public function dump($data) //
//
diff
--- Original // 80 chars
+++ New //
@@ @@ //
return; //
} //
//
- public function fun2($arg1, array $arg2 = [], \ArrayAccess $arg3 = null, bool $bool = true, \Iterator $thisLastArgument = null)
- { //
+ public function fun2( //
+ $arg1, //
+ array $arg2 = [], //
+ \ArrayAccess $arg3 = null, //
+ bool $bool = true, //
+ \Iterator $thisLastArgument = null //
+ ) { //
return; //
} //
//
- public function fun3( //
- $arg1, //
- array $arg2 = [] //
- ) { //
+ public function fun3($arg1, array $arg2 = []) //
+ { //
return; //
} //
} //
//
diff
--- Original // 80 chars
+++ New //
@@ @@ //
return; //
} //
//
- public function fun2($arg1, array $arg2 = [], \ArrayAccess $arg3 = null, bool $bool = true, \Iterator $thisLastArgument = null)
- { //
+ public function fun2( //
+ $arg1, //
+ array $arg2 = [], //
+ \ArrayAccess $arg3 = null, //
+ bool $bool = true, //
+ \Iterator $thisLastArgument = null //
+ ) { //
return; //
} //
//
- public function fun3( //
- $arg1, //
- array $arg2 = [] //
- ) { //
+ public function fun3($arg1, array $arg2 = []) //
+ { //
return; //
} //
} //
//
diff
--- Original // 80 chars
+++ New //
@@ @@ //
do { //
// ... //
} while (true); //
+ //
foreach (['foo', 'bar'] as $str) { //
// ... //
} //
+ //
if (true === false) { //
// ... //
} //
- //
//
while (true) { //
// ... //
//
diff
--- Original // 80 chars
+++ New //
@@ @@ //
*/ //
private $name; //
//
- // @var string | null //
+ /** //
+ * @var string | null //
+ */ //
private $value; //
//
/** //
@@ @@ //
$this->name = $name; //
} //
//
- // Get the name //
- // //
- // @return string //
+ /** //
+ * Get the name //
+ * //
+ * @return string //
+ */ //
public function getName() //
{ //
return $this->name; //
} //
//
- // Get the value //
- // @return null | string //
+ /** //
+ * Get the value //
+ * @return null | string //
+ */ //
public function getValue() //
{ //
return $this->value; //
} //
//
- // Set the value //
- //
- // @param string $value //
+ /** //
+ * Set the value //
+ * @param string $value //
+ */ //
public function setValue($value) //
{ //
$this->value = $value; //
} //
} //
//
diff
--- Original // 80 chars
+++ New //
@@ @@ //
*/ //
public function fun1(Model\User $user, Model\Address $address = null) { //
return; //
- //
- $user->setName('foo'); //
- //
- return $this; //
} //
//
/** //
@@ @@ //
switch ($this->status) { //
case 1: //
return $this->name; //
- break; //
default: //
return $this; //
- return $this; //
} //
} //
//
@@ @@ //
*/ //
public function buildCallable() //
{ //
- return function () { return true; return false; }; //
+ return function () { return true; }; //
} //
} //
//
diff
--- Original // 80 chars
+++ New //
@@ @@ //
use Doctrine\DBAL\Schema\Schema; //
use Doctrine\Migrations\AbstractMigration; //
//
-/** //
- * Auto-generated Migration: Please modify to your needs! //
- */ //
final class Version20190323095102 extends AbstractMigration //
{ //
- public function getDescription() //
- { //
- return ''; //
- } //
//
public function up(Schema $schema) //
{ //
- // this up() migration is auto-generated, please modify it to your needs//
$this->abortIf('mysql' !== $this->connection->getDatabasePlatform()->getName(), 'Migration can only be executed safely on \'mysql\'.');
//
$this->addSql('CREATE TABLE admin (identifier CHAR(36) NOT NULL COMMENT \'(DC2Type:guid)\', PRIMARY KEY(identifier)) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci ENGINE = InnoDB');
@@ @@ //
//
public function down(Schema $schema) //
{ //
- // this down() migration is auto-generated, please modify it to your needs
$this->abortIf('mysql' !== $this->connection->getDatabasePlatform()->getName(), 'Migration can only be executed safely on \'mysql\'.');
//
$this->addSql('DROP TABLE admin'); //
} //
} //
//
diff
--- Original // 80 chars
+++ New //
@@ @@ //
use Doctrine\DBAL\Schema\Schema; //
use Doctrine\Migrations\AbstractMigration; //
//
-/** //
- * Auto-generated Migration: Please modify to your needs! //
- */ //
final class Version20190323095102 extends AbstractMigration //
{ //
- public function getDescription() //
- { //
- return ''; //
- } //
//
public function up(Schema $schema) //
{ //
- // this up() migration is auto-generated, please modify it to your needs//
$this->abortIf('mysql' !== $this->connection->getDatabasePlatform()->getName(), 'Migration can only be executed safely on \'mysql\'.');
//
$this->addSql('CREATE TABLE admin (identifier CHAR(36) NOT NULL COMMENT \'(DC2Type:guid)\', PRIMARY KEY(identifier)) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci ENGINE = InnoDB');
@@ @@ //
//
public function down(Schema $schema) //
{ //
- // this down() migration is auto-generated, please modify it to your needs
$this->abortIf('mysql' !== $this->connection->getDatabasePlatform()->getName(), 'Migration can only be executed safely on \'mysql\'.');
//
$this->addSql('DROP TABLE admin'); //
} //
} //
//
diff
--- Original // 80 chars
+++ New //
@@ @@ //
class TheSpec extends ObjectBehavior //
{ //
//
- function letGo($file) { //
+ function let($file) { //
return; //
} //
//
- private function thePrivateMethod() { //
+ function letGo($file) { //
return; //
} //
//
- public function itIsNotASpec($file) { //
+ function it_is_a_spec($file) { //
return; //
} //
//
- public function it_is_a_spec($file) { //
+ function its_other_function($file) { //
return; //
} //
//
- public function let($file) { //
+ private function thePrivateMethod() { //
return; //
} //
//
- public function its_other_function($file) { //
+ public function itIsNotASpec($file) { //
return; //
} //
} //
//
diff
--- Original // 80 chars
+++ New //
@@ @@ //
class TheSpec extends ObjectBehavior //
{ //
//
- function letGo($file) { //
+ function let($file) { //
return; //
} //
//
- private function thePrivateMethod() { //
+ function letGo($file) { //
return; //
} //
//
- public function itIsNotASpec($file) { //
+ function it_is_a_spec($file) { //
return; //
} //
//
- public function it_is_a_spec($file) { //
+ function its_other_function($file) { //
return; //
} //
//
- public function let($file) { //
+ private function thePrivateMethod() { //
return; //
} //
//
- public function its_other_function($file) { //
+ public function itIsNotASpec($file) { //
return; //
} //
} //
//