mirror of https://github.com/rectorphp/rector.git synced 2025-02-24 11:44:14 +01:00

Tomas Votruba 9eaa3185c1 update docs

Signed-off-by: Tomas Votruba <tomas.vot@gmail.com>

2018-12-06 01:13:36 +01:00

64 KiB

Raw Blame History

All Rectors Overview

Projects
General

Projects

CakePHP\MethodCall
CodeQuality\Assign
CodeQuality\BooleanAnd
CodeQuality\Expression
CodeQuality\Foreach_
CodeQuality\FuncCall
CodeQuality\Identical
CodeQuality\If_
CodeQuality\Return_
CodeQuality\Stmt
CodeQuality\Ternary
CodingStyle\FuncCall
CodingStyle\Identical
CodingStyle\If_
CodingStyle\Switch_
Doctrine
DomainDrivenDesign\ValueObjectRemover
Guzzle\MethodCall
Jms\Property
PHPStan\Assign
PHPStan\Cast
PHPUnit
PHPUnit\Foreach_
PHPUnit\SpecificMethod
PhpParser
Php\Assign
Php\BinaryOp
Php\ClassConst
Php\ConstFetch
Php\Each
Php\FuncCall
Php\FunctionLike
Php\List_
Php\Name
Php\Property
Php\String_
Php\Ternary
Php\TryCatch
Php\Unset_
Sensio\FrameworkExtraBundle
Silverstripe
Sylius\Review
Symfony\Console
Symfony\Controller
Symfony\DependencyInjection
Symfony\Form
Symfony\FrameworkBundle
Symfony\HttpKernel
Symfony\MethodCall
Symfony\New_
Symfony\Process
Symfony\Validator
Symfony\VarDumper
Symfony\Yaml
Twig

CakePHP\MethodCall

`ModalToGetSetRector`

class: Rector\CakePHP\Rector\MethodCall\ModalToGetSetRector

Changes combined set/get value() to specific getValue() or setValue(x).

 $object = new InstanceConfigTrait;

-$config = $object->config();
-$config = $object->config('key');
+$config = $object->getConfig();
+$config = $object->getConfig('key');

-$object->config('key', 'value');
-$object->config(['key' => 'value']);
+$object->setConfig('key', 'value');
+$object->setConfig(['key' => 'value']);

CodeQuality\Assign

`CombinedAssignRector`

class: Rector\CodeQuality\Rector\Assign\CombinedAssignRector

Simplify $value = $value + 5; assignments to shorter ones

-$value = $value + 5;
+$value += 5;

CodeQuality\BooleanAnd

`SimplifyEmptyArrayCheckRector`

class: Rector\CodeQuality\Rector\BooleanAnd\SimplifyEmptyArrayCheckRector

Simplify is_array and empty functions combination into a simple identical check for an empty array

-is_array($values) && empty($values)
+$values === []

CodeQuality\Expression

`SimplifyMirrorAssignRector`

class: Rector\CodeQuality\Rector\Expression\SimplifyMirrorAssignRector

Removes unneeded $a = $a assigns

-$a = $a;

CodeQuality\Foreach_

`ForeachToInArrayRector`

class: Rector\CodeQuality\Rector\Foreach_\ForeachToInArrayRector

Simplify foreach loops into in_array when possible

-foreach ($items as $item) {
-    if ($item === "something") {
-        return true;
-    }
-}
-
-return false;
+in_array("something", $items, true);

`SimplifyForeachToCoalescingRector`

class: Rector\CodeQuality\Rector\Foreach_\SimplifyForeachToCoalescingRector

Changes foreach that returns set value to ??

-foreach ($this->oldToNewFunctions as $oldFunction => $newFunction) {
-    if ($currentFunction === $oldFunction) {
-        return $newFunction;
-    }
-}
-
-return null;
+return $this->oldToNewFunctions[$currentFunction] ?? null;

CodeQuality\FuncCall

`InArrayAndArrayKeysToArrayKeyExistsRector`

class: Rector\CodeQuality\Rector\FuncCall\InArrayAndArrayKeysToArrayKeyExistsRector

Simplify in_array and array_keys functions combination into array_key_exists when array_keys has one argument only

-in_array("key", array_keys($array), true);
+array_key_exists("key", $array);

`SimplifyInArrayValuesRector`

class: Rector\CodeQuality\Rector\FuncCall\SimplifyInArrayValuesRector

Removes unneeded array_values() in in_array() call

-in_array("key", array_values($array), true);
+in_array("key", $array, true);

`SimplifyFuncGetArgsCountRector`

class: Rector\CodeQuality\Rector\FuncCall\SimplifyFuncGetArgsCountRector

Simplify count of func_get_args() to fun_num_args()

-count(func_get_args());
+func_num_args();

`SimplifyStrposLowerRector`

class: Rector\CodeQuality\Rector\FuncCall\SimplifyStrposLowerRector

Simplify strpos(strtolower(), "...") calls

-strpos(strtolower($var), "...")"
+stripos($var, "...")"

CodeQuality\Identical

`GetClassToInstanceOfRector`

class: Rector\CodeQuality\Rector\Identical\GetClassToInstanceOfRector

Changes comparison with get_class to instanceof

-if (EventsListener::class === get_class($event->job)) { }
+if ($event->job instanceof EventsListener) { }

`SimplifyConditionsRector`

class: Rector\CodeQuality\Rector\Identical\SimplifyConditionsRector

Simplify conditions

-if (! ($foo !== 'bar')) {...
+if ($foo === 'bar') {...

`SimplifyArraySearchRector`

class: Rector\CodeQuality\Rector\Identical\SimplifyArraySearchRector

Simplify array_search to in_array

-array_search("searching", $array) !== false;
+in_array("searching", $array, true);

-array_search("searching", $array) != false;
+in_array("searching", $array);

CodeQuality\If_

`SimplifyIfNotNullReturnRector`

class: Rector\CodeQuality\Rector\If_\SimplifyIfNotNullReturnRector

Changes redundant null check to instant return

 $newNode = 'something ;
-if ($newNode !== null) {
-    return $newNode;
-}
-
-return null;
+return $newNode;

`SimplifyIfReturnBoolRector`

class: Rector\CodeQuality\Rector\If_\SimplifyIfReturnBoolRector

Shortens if return false/true to direct return

-if (strpos($docToken->getContent(), "\n") === false) {
-    return true;
-}
-
-return false;
+return strpos($docToken->getContent(), "\n") === false;

CodeQuality\Return_

`SimplifyUselessVariableRector`

class: Rector\CodeQuality\Rector\Return_\SimplifyUselessVariableRector

Removes useless variable assigns

 function () {
-    $a = true;
-    return $a;
+    return true;
 };

CodeQuality\Stmt

`DeadCodeRemovingRector`

class: Rector\CodeQuality\Rector\Stmt\DeadCodeRemovingRector

Removes dead code that is nowhere run

-$value = 5;
-$value;
+$value = 5;

CodeQuality\Ternary

`UnnecessaryTernaryExpressionRector`

class: Rector\CodeQuality\Rector\Ternary\UnnecessaryTernaryExpressionRector

Remove unnecessary ternary expressions.

-$foo === $bar ? true : false;
+$foo === $bar;

CodingStyle\FuncCall

`SimpleArrayCallableToStringRector`

class: Rector\CodingStyle\Rector\FuncCall\SimpleArrayCallableToStringRector

Changes redundant anonymous bool functions to simple calls

-$paths = array_filter($paths, function ($path): bool {
-    return is_dir($path);
-});
+array_filter($paths, "is_dir");

CodingStyle\Identical

`IdenticalFalseToBooleanNotRector`

class: Rector\CodingStyle\Rector\Identical\IdenticalFalseToBooleanNotRector

Changes === false to negate !

-if ($something === false) {}
+if (! $something) {}

CodingStyle\If_

`NullableCompareToNullRector`

class: Rector\CodingStyle\Rector\If_\NullableCompareToNullRector

Changes negate of empty comparison of nullable value to explicit === or !== compare

 /** @var stdClass|null $value */
-if ($value) {
+if ($value !== null) {
 }

-if (!$value) {
+if ($value === null) {
 }

CodingStyle\Switch_

`BinarySwitchToIfElseRector`

class: Rector\CodingStyle\Rector\Switch_\BinarySwitchToIfElseRector

Changes switch with 2 options to if-else

-switch ($foo) {
-    case 'my string':
-        $result = 'ok';
-    break;
-
-    default:
-        $result = 'not ok';
+if ($foo == 'my string') {
+    $result = 'ok;
+} else {
+    $result = 'not ok';
 }

Doctrine

`AliasToClassRector`

class: Rector\Doctrine\Rector\AliasToClassRector

Replaces doctrine alias with class.

 $entityManager = new Doctrine\ORM\EntityManager();
-$entityManager->getRepository("AppBundle:Post");
+$entityManager->getRepository(\App\Entity\Post::class);

DomainDrivenDesign\ValueObjectRemover

`ValueObjectRemoverDocBlockRector`

class: Rector\DomainDrivenDesign\Rector\ValueObjectRemover\ValueObjectRemoverDocBlockRector

Turns defined value object to simple types in doc blocks

services:
    Rector\DomainDrivenDesign\Rector\ValueObjectRemover\ValueObjectRemoverDocBlockRector:
        $valueObjectsToSimpleTypes:
            ValueObject: string

↓

 /**
- * @var ValueObject|null
+ * @var string|null
  */
 private $name;

services:
    Rector\DomainDrivenDesign\Rector\ValueObjectRemover\ValueObjectRemoverDocBlockRector:
        $valueObjectsToSimpleTypes:
            ValueObject: string

↓

-/** @var ValueObject|null */
+/** @var string|null */
 $name;

`ValueObjectRemoverRector`

class: Rector\DomainDrivenDesign\Rector\ValueObjectRemover\ValueObjectRemoverRector

Remove values objects and use directly the value.

services:
    Rector\DomainDrivenDesign\Rector\ValueObjectRemover\ValueObjectRemoverRector:
        $valueObjectsToSimpleTypes:
            ValueObject: string

↓

-$name = new ValueObject("name");
+$name = "name";

services:
    Rector\DomainDrivenDesign\Rector\ValueObjectRemover\ValueObjectRemoverRector:
        $valueObjectsToSimpleTypes:
            ValueObject: string

↓

-function someFunction(ValueObject $name) { }
+function someFunction(string $name) { }

services:
    Rector\DomainDrivenDesign\Rector\ValueObjectRemover\ValueObjectRemoverRector:
        $valueObjectsToSimpleTypes:
            ValueObject: string

↓

-function someFunction(): ValueObject { }
+function someFunction(): string { }

services:
    Rector\DomainDrivenDesign\Rector\ValueObjectRemover\ValueObjectRemoverRector:
        $valueObjectsToSimpleTypes:
            ValueObject: string

↓

-function someFunction(): ?ValueObject { }
+function someFunction(): ?string { }

Guzzle\MethodCall

`MessageAsArrayRector`

class: Rector\Guzzle\Rector\MethodCall\MessageAsArrayRector

Changes getMessage(..., true) to getMessageAsArray()

 /** @var GuzzleHttp\Message\MessageInterface */
-$value = $message->getMessage('key', true);
+$value = $message->getMessageAsArray('key');

Jms\Property

`JmsInjectAnnotationRector`

class: Rector\Jms\Rector\Property\JmsInjectAnnotationRector

Changes properties with @JMS\DiExtraBundle\Annotation\Inject to constructor injection

 use JMS\DiExtraBundle\Annotation as DI;

 class SomeController
 {
     /**
-     * @DI\Inject("entity.manager")
+     * @var EntityManager
      */
     private $entityManager;
+
+    public function __construct(EntityManager $entityManager)
+    {
+        $this->entityManager = entityManager;
+    }
 }

PHPStan\Assign

`PHPStormVarAnnotationRector`

class: Rector\PHPStan\Rector\Assign\PHPStormVarAnnotationRector

Change various @var annotation formats to one PHPStorm understands

-$config = 5;
-/** @var \Shopsys\FrameworkBundle\Model\Product\Filter\ProductFilterConfig $config */
+/** @var \Shopsys\FrameworkBundle\Model\Product\Filter\ProductFilterConfig $config */
+$config = 5;

PHPStan\Cast

`RecastingRemovalRector`

class: Rector\PHPStan\Rector\Cast\RecastingRemovalRector

Removes recasting of the same type

 $string = '';
-$string = (string) $string;
+$string = $string;

 $array = [];
-$array = (array) $array;
+$array = $array;

PHPUnit

`ExceptionAnnotationRector`

class: Rector\PHPUnit\Rector\ExceptionAnnotationRector

Takes setExpectedException() 2nd and next arguments to own methods in PHPUnit.

-/**
- * @expectedException Exception
- * @expectedExceptionMessage Message
- */
 public function test()
 {
+    $this->expectException('Exception');
+    $this->expectExceptionMessage('Message');
     // tested code
 }

`DelegateExceptionArgumentsRector`

class: Rector\PHPUnit\Rector\DelegateExceptionArgumentsRector

Takes setExpectedException() 2nd and next arguments to own methods in PHPUnit.

-$this->setExpectedException(Exception::class, "Message", "CODE");
+$this->setExpectedException(Exception::class);
+$this->expectExceptionMessage("Message");
+$this->expectExceptionCode("CODE");

`ArrayToYieldDataProviderRector`

class: Rector\PHPUnit\Rector\ArrayToYieldDataProviderRector

Turns method data providers in PHPUnit from arrays to yield

 /**
- * @return mixed[]
  */
-public function provide(): array
+public function provide(): Iterator
 {
-    return [
-        ['item']
-    ]
+    yield ['item'];
 }

`TryCatchToExpectExceptionRector`

class: Rector\PHPUnit\Rector\TryCatchToExpectExceptionRector

Turns try/catch to expectException() call

-try {
-	$someService->run();
-} catch (Throwable $exception) {
-    $this->assertInstanceOf(RuntimeException::class, $e);
-    $this->assertContains('There was an error executing the following script', $e->getMessage());
-}
+$this->expectException(RuntimeException::class);
+$this->expectExceptionMessage('There was an error executing the following script');
+$someService->run();

`GetMockRector`

class: Rector\PHPUnit\Rector\GetMockRector

Turns getMock*() methods to createMock()

-$this->getMock("Class");
+$this->createMock("Class");

-$this->getMockWithoutInvokingTheOriginalConstructor("Class");
+$this->createMock("Class");

PHPUnit\Foreach_

`SimplifyForeachInstanceOfRector`

class: Rector\PHPUnit\Rector\Foreach_\SimplifyForeachInstanceOfRector

Simplify unnecessary foreach check of instances

-foreach ($foos as $foo) {
-    $this->assertInstanceOf(\SplFileInfo::class, $foo);
-}
+$this->assertContainsOnlyInstancesOf(\SplFileInfo::class, $foos);

PHPUnit\SpecificMethod

`AssertNotOperatorRector`

class: Rector\PHPUnit\Rector\SpecificMethod\AssertNotOperatorRector

Turns not-operator comparisons to their method name alternatives in PHPUnit TestCase

-$this->assertTrue(!$foo, "message");
+$this->assertFalse($foo, "message");

-$this->assertFalse(!$foo, "message");
+$this->assertTrue($foo, "message");

`AssertComparisonToSpecificMethodRector`

class: Rector\PHPUnit\Rector\SpecificMethod\AssertComparisonToSpecificMethodRector

Turns comparison operations to their method name alternatives in PHPUnit TestCase

-$this->assertTrue($foo === $bar, "message");
+$this->assertSame($bar, $foo, "message");

-$this->assertFalse($foo >= $bar, "message");
+$this->assertLessThanOrEqual($bar, $foo, "message");

`AssertPropertyExistsRector`

class: Rector\PHPUnit\Rector\SpecificMethod\AssertPropertyExistsRector

Turns property_exists comparisons to their method name alternatives in PHPUnit TestCase

-$this->assertTrue(property_exists(new Class, "property"), "message");
+$this->assertClassHasAttribute("property", "Class", "message");

-$this->assertFalse(property_exists(new Class, "property"), "message");
+$this->assertClassNotHasAttribute("property", "Class", "message");

`AssertTrueFalseInternalTypeToSpecificMethodRector`

class: Rector\PHPUnit\Rector\SpecificMethod\AssertTrueFalseInternalTypeToSpecificMethodRector

Turns true/false with internal type comparisons to their method name alternatives in PHPUnit TestCase

-$this->assertTrue(is_{internal_type}($anything), "message");
+$this->assertInternalType({internal_type}, $anything, "message");

-$this->assertFalse(is_{internal_type}($anything), "message");
+$this->assertNotInternalType({internal_type}, $anything, "message");

`AssertIssetToSpecificMethodRector`

class: Rector\PHPUnit\Rector\SpecificMethod\AssertIssetToSpecificMethodRector

Turns isset comparisons to their method name alternatives in PHPUnit TestCase

-$this->assertTrue(isset($anything->foo));
+$this->assertFalse(isset($anything["foo"]), "message");

-$this->assertObjectHasAttribute("foo", $anything);
+$this->assertArrayNotHasKey("foo", $anything, "message");

`AssertFalseStrposToContainsRector`

class: Rector\PHPUnit\Rector\SpecificMethod\AssertFalseStrposToContainsRector

Turns strpos/stripos comparisons to their method name alternatives in PHPUnit TestCase

-$this->assertFalse(strpos($anything, "foo"), "message");
+$this->assertNotContains("foo", $anything, "message");

-$this->assertNotFalse(stripos($anything, "foo"), "message");
+$this->assertContains("foo", $anything, "message");

`AssertSameBoolNullToSpecificMethodRector`

class: Rector\PHPUnit\Rector\SpecificMethod\AssertSameBoolNullToSpecificMethodRector

Turns same bool and null comparisons to their method name alternatives in PHPUnit TestCase

-$this->assertSame(null, $anything);
+$this->assertNull($anything);

-$this->assertNotSame(false, $anything);
+$this->assertNotFalse($anything);

`AssertCompareToSpecificMethodRector`

class: Rector\PHPUnit\Rector\SpecificMethod\AssertCompareToSpecificMethodRector

Turns vague php-only method in PHPUnit TestCase to more specific

-$this->assertSame(10, count($anything), "message");
+$this->assertCount(10, $anything, "message");

-$this->assertSame($value, {function}($anything), "message");
+$this->assert{function}($value, $anything, "message\");

-$this->assertEquals($value, {function}($anything), "message");
+$this->assert{function}($value, $anything, "message\");

-$this->assertNotSame($value, {function}($anything), "message");
+$this->assertNot{function}($value, $anything, "message")

-$this->assertNotEquals($value, {function}($anything), "message");
+$this->assertNot{function}($value, $anything, "message")

`AssertRegExpRector`

class: Rector\PHPUnit\Rector\SpecificMethod\AssertRegExpRector

Turns preg_match comparisons to their method name alternatives in PHPUnit TestCase

-$this->assertSame(1, preg_match("/^Message for ".*"\.$/", $string), $message);
+$this->assertRegExp("/^Message for ".*"\.$/", $string, $message);

-$this->assertEquals(false, preg_match("/^Message for ".*"\.$/", $string), $message);
+$this->assertNotRegExp("/^Message for ".*"\.$/", $string, $message);

`AssertInstanceOfComparisonRector`

class: Rector\PHPUnit\Rector\SpecificMethod\AssertInstanceOfComparisonRector

Turns instanceof comparisons to their method name alternatives in PHPUnit TestCase

-$this->assertTrue($foo instanceof Foo, "message");
+$this->assertFalse($foo instanceof Foo, "message");

-$this->assertInstanceOf("Foo", $foo, "message");
+$this->assertNotInstanceOf("Foo", $foo, "message");

`AssertTrueFalseToSpecificMethodRector`

class: Rector\PHPUnit\Rector\SpecificMethod\AssertTrueFalseToSpecificMethodRector

Turns true/false comparisons to their method name alternatives in PHPUnit TestCase when possible

-$this->assertTrue(is_readable($readmeFile), "message");
+$this->assertIsReadable($readmeFile, "message");

PhpParser

`RemoveNodeRector`

class: Rector\PhpParser\Rector\RemoveNodeRector

Turns integer return to remove node to constant in NodeVisitor of PHP-Parser

 public function leaveNode()
 {
-    return false;
+    return NodeTraverser::REMOVE_NODE;
 }

`ParamAndStaticVarNameRector`

class: Rector\PhpParser\Rector\ParamAndStaticVarNameRector

Turns old string var to var->name sub-variable in Node of PHP-Parser

-$paramNode->name;
+$paramNode->var->name;

-$staticVarNode->name;
+$staticVarNode->var->name;

`IdentifierRector`

class: Rector\PhpParser\Rector\IdentifierRector

Turns node string names to Identifier object in php-parser

 $constNode = new PhpParser\Node\Const_;
-$name = $constNode->name;
+$name = $constNode->name->toString();'

`CatchAndClosureUseNameRector`

class: Rector\PhpParser\Rector\CatchAndClosureUseNameRector

Turns $catchNode->var to its new name property in php-parser

-$catchNode->var;
+$catchNode->var->name

`SetLineRector`

class: Rector\PhpParser\Rector\SetLineRector

Turns standalone line method to attribute in Node of PHP-Parser

-$node->setLine(5);
+$node->setAttribute("line", 5);

`UseWithAliasRector`

class: Rector\PhpParser\Rector\UseWithAliasRector

Turns use property to method and $node->alias to last name in UseAlias Node of PHP-Parser

-$node->alias;
+$node->getAlias();

-$node->name->getLast();
+$node->alias

Php\Assign

`AssignArrayToStringRector`

class: Rector\Php\Rector\Assign\AssignArrayToStringRector

String cannot be turned into array by assignment anymore

-$string = '';
+$string = [];
 $string[] = 1;

Php\BinaryOp

`IsCountableRector`

class: Rector\Php\Rector\BinaryOp\IsCountableRector

Changes is_array + Countable check to is_countable

-is_array($foo) || $foo instanceof Countable;
+is_countable($foo);

`IsIterableRector`

class: Rector\Php\Rector\BinaryOp\IsIterableRector

Changes is_array + Traversable check to is_iterable

-is_array($foo) || $foo instanceof Traversable;
+is_iterable($foo);

Php\ClassConst

`PublicConstantVisibilityRector`

class: Rector\Php\Rector\ClassConst\PublicConstantVisibilityRector

Add explicit public constant visibility.

 class SomeClass
 {
-    const HEY = 'you';
+    public const HEY = 'you';
 }

Php\ConstFetch

`SensitiveConstantNameRector`

class: Rector\Php\Rector\ConstFetch\SensitiveConstantNameRector

Changes case insensitive constants to sensitive ones.

 define('FOO', 42, true);
 var_dump(FOO);
-var_dump(foo);
+var_dump(FOO);

`BarewordStringRector`

class: Rector\Php\Rector\ConstFetch\BarewordStringRector

Changes unquoted non-existing constants to strings

-var_dump(VAR);
+var("VAR");

Php\Each

`WhileEachToForeachRector`

class: Rector\Php\Rector\Each\WhileEachToForeachRector

each() function is deprecated, use foreach() instead.

-while (list($key, $callback) = each($callbacks)) {
+foreach ($callbacks as $key => $callback) {
     // ...
 }

-while (list($key) = each($callbacks)) {
+foreach (array_keys($callbacks) as $key) {
     // ...
 }

`ListEachRector`

class: Rector\Php\Rector\Each\ListEachRector

each() function is deprecated, use foreach() instead.

-list($key, $callback) = each($callbacks);
+$key = key($opt->option);
+$val = current($opt->option);

Php\FuncCall

`RandomFunctionRector`

class: Rector\Php\Rector\FuncCall\RandomFunctionRector

Changes rand, srand and getrandmax by new md_* alternatives.

-rand();
+mt_rand();

`TrailingCommaArgumentsRector`

class: Rector\Php\Rector\FuncCall\TrailingCommaArgumentsRector

Adds trailing commas to function and methods calls

 calling(
     $one,
-    $two
+    $two,
 );

`ArrayKeyFirstLastRector`

class: Rector\Php\Rector\FuncCall\ArrayKeyFirstLastRector

Make use of array_key_first() and array_key_last()

-reset($items);
-$firstKey = key($items);
+$firstKey = array_key_first($items);

-end($items);
-$lastKey = key($items);
+$lastKey = array_key_last($items);

`CallUserMethodRector`

class: Rector\Php\Rector\FuncCall\CallUserMethodRector

Changes call_user_method()/call_user_method_array() to call_user_func()/call_user_func_array()

-call_user_method($method, $obj, "arg1", "arg2");
+call_user_func(array(&$obj, "method"), "arg1", "arg2");

`StringifyStrNeedlesRector`

class: Rector\Php\Rector\FuncCall\StringifyStrNeedlesRector

Makes needles explicit strings

 $needle = 5;
-$fivePosition = strpos('725', $needle);
+$fivePosition = strpos('725', (string) $needle);

`CountOnNullRector`

class: Rector\Php\Rector\FuncCall\CountOnNullRector

Changes count() on null to safe ternary check

 $values = null;
-$count = count($values);
+$count = is_array($values) || $values instanceof Countable ? count($values) : 0;

`SensitiveDefineRector`

class: Rector\Php\Rector\FuncCall\SensitiveDefineRector

Changes case insensitive constants to sensitive ones.

-define('FOO', 42, true);
+define('FOO', 42);

`MultiDirnameRector`

class: Rector\Php\Rector\FuncCall\MultiDirnameRector

Changes multiple dirname() calls to one with nesting level

-dirname(dirname($path));
+dirname($path, 2);

`JsonThrowOnErrorRector`

class: Rector\Php\Rector\FuncCall\JsonThrowOnErrorRector

Adds JSON_THROW_ON_ERROR to json_encode() and json_decode() to throw JsonException on error

-json_encode($content);
-json_decode($json);
+json_encode($content, JSON_THROW_ON_ERROR
+json_decode($json, null, null, JSON_THROW_ON_ERROR););

`EregToPregMatchRector`

class: Rector\Php\Rector\FuncCall\EregToPregMatchRector

Changes ereg*() to preg*() calls

-ereg("hi")
+preg_match("#hi#");

`PowToExpRector`

class: Rector\Php\Rector\FuncCall\PowToExpRector

Changes pow(val, val2) to ** (exp) parameter

-pow(1, 2);
+1**2;

Php\FunctionLike

`ExceptionHandlerTypehintRector`

class: Rector\Php\Rector\FunctionLike\ExceptionHandlerTypehintRector

Changes property @var annotations from annotation to type.

-function handler(Exception $exception) { ... }
+function handler(Throwable $exception) { ... }
 set_exception_handler('handler');

`ParamScalarTypehintRector`

class: Rector\Php\Rector\FunctionLike\ParamScalarTypehintRector

Change @param types to scalar typehints if not a BC-break

 <?php

 class ParentClass
 {
     /**
      * @param int $number
      */
     public function keep($number)
     {
     }
 }

 final class ChildClass extends ParentClass
 {
     /**
      * @param int $number
      */
     public function keep($number)
     {
     }

     /**
      * @param int $number
      */
-    public function change($number)
+    public function change(int $number)
     {
     }
 }

`Php4ConstructorRector`

class: Rector\Php\Rector\FunctionLike\Php4ConstructorRector

Changes PHP 4 style constructor to __construct.

 class SomeClass
 {
-    public function SomeClass()
+    public function __construct()
     {
     }
 }

`ReturnScalarTypehintRector`

class: Rector\Php\Rector\FunctionLike\ReturnScalarTypehintRector

Change @return types to scalar typehints if not a BC-break

 <?php

 class SomeClass
 {
     /**
      * @return int
      */
-    public function getCount()
+    public function getCount(): int
     {
     }
 }

Php\List_

`ListSplitStringRector`

class: Rector\Php\Rector\List_\ListSplitStringRector

list() cannot split string directly anymore, use str_split()

-list($foo) = "string";
+list($foo) = str_split("string");

`EmptyListRector`

class: Rector\Php\Rector\List_\EmptyListRector

list() cannot be empty

-list() = $values;
+list($generated) = $values;

`ListSwapArrayOrderRector`

class: Rector\Php\Rector\List_\ListSwapArrayOrderRector

list() assigns variables in reverse order - relevant in array assign

-list($a[], $a[]) = [1, 2];
+list($a[], $a[]) = array_reverse([1, 2])];

Php\Name

`ReservedObjectRector`

class: Rector\Php\Rector\Name\ReservedObjectRector

Changes reserved "Object" name to "Object" where can be configured

-class Object
+class SmartObject
 {
 }

Php\Property

`TypedPropertyRector`

class: Rector\Php\Rector\Property\TypedPropertyRector

Changes property @var annotations from annotation to type.

 final class SomeClass
 {
-    /**
-     * @var int
-     */
-    private count;
+    private int count;
 }

Php\String_

`SensitiveHereNowDocRector`

class: Rector\Php\Rector\String_\SensitiveHereNowDocRector

Changes heredoc/nowdoc that contains closing word to safe wrapper name

-$value = <<<A
+$value = <<<A_WRAP
     A
-A
+A_WRAP

Php\Ternary

`TernaryToNullCoalescingRector`

class: Rector\Php\Rector\Ternary\TernaryToNullCoalescingRector

Changes unneeded null check to ?? operator

-$value === null ? 10 : $value;
+$value ?? 10;

-isset($value) ? $value : 10;
+$value ?? 10;

Php\TryCatch

`MultiExceptionCatchRector`

class: Rector\Php\Rector\TryCatch\MultiExceptionCatchRector

Changes multi catch of same exception to single one | separated.

 try {
    // Some code...
-} catch (ExceptionType1 $exception) {
-   $sameCode;
-} catch (ExceptionType2 $exception) {
+} catch (ExceptionType1 | ExceptionType2 $exception) {
    $sameCode;
 }

Php\Unset_

`UnsetCastRector`

class: Rector\Php\Rector\Unset_\UnsetCastRector

Removes (unset) cast

-$value = (unset) $value;
+$value = null;

Sensio\FrameworkExtraBundle

`TemplateAnnotationRector`

class: Rector\Sensio\Rector\FrameworkExtraBundle\TemplateAnnotationRector

Turns @Template annotation to explicit method call in Controller of FrameworkExtraBundle in Symfony

-/**
- * @Template()
- */
 public function indexAction()
 {
+    return $this->render("index.html.twig");
 }

Silverstripe

`ConstantToStaticCallRector`

class: Rector\Silverstripe\Rector\ConstantToStaticCallRector

Turns defined constant to static method call.

-SS_DATABASE_NAME;
+Environment::getEnv("SS_DATABASE_NAME");

`DefineConstantToStaticCallRector`

class: Rector\Silverstripe\Rector\DefineConstantToStaticCallRector

Turns defined function call to static method call.

-defined("SS_DATABASE_NAME");
+Environment::getEnv("SS_DATABASE_NAME");

Sylius\Review

`ReplaceCreateMethodWithoutReviewerRector`

class: Rector\Sylius\Rector\Review\ReplaceCreateMethodWithoutReviewerRector

Turns createForSubjectWithReviewer() with null review to standalone method in Sylius

-$this->createForSubjectWithReviewer($subject, null)
+$this->createForSubject($subject)

Symfony\Console

`ConsoleExceptionToErrorEventConstantRector`

class: Rector\Symfony\Rector\Console\ConsoleExceptionToErrorEventConstantRector

Turns old event name with EXCEPTION to ERROR constant in Console in Symfony

-"console.exception"
+Symfony\Component\Console\ConsoleEvents::ERROR

-Symfony\Component\Console\ConsoleEvents::EXCEPTION
+Symfony\Component\Console\ConsoleEvents::ERROR

Symfony\Controller

`AddFlashRector`

class: Rector\Symfony\Rector\Controller\AddFlashRector

Turns long flash adding to short helper method in Controller in Symfony

 class SomeController extends Controller
 {
     public function some(Request $request)
     {
-        $request->getSession()->getFlashBag()->add("success", "something");
+        $this->addFlash("success", "something");
     }
 }

`RedirectToRouteRector`

class: Rector\Symfony\Rector\Controller\RedirectToRouteRector

Turns redirect to route to short helper method in Controller in Symfony

-$this->redirect($this->generateUrl("homepage"));
+$this->redirectToRoute("homepage");

`ActionSuffixRemoverRector`

class: Rector\Symfony\Rector\Controller\ActionSuffixRemoverRector

Removes Action suffixes from methods in Symfony Controllers

 class SomeController
 {
-    public function indexAction()
+    public function index()
     {
     }
 }

Symfony\DependencyInjection

`ContainerBuilderCompileEnvArgumentRector`

class: Rector\Symfony\Rector\DependencyInjection\ContainerBuilderCompileEnvArgumentRector

Turns old default value to parameter in ContinerBuilder->build() method in DI in Symfony

-$containerBuilder = new Symfony\Component\DependencyInjection\ContainerBuilder(); $containerBuilder->compile();
+$containerBuilder = new Symfony\Component\DependencyInjection\ContainerBuilder(); $containerBuilder->compile(true);

Symfony\Form

`FormIsValidRector`

class: Rector\Symfony\Rector\Form\FormIsValidRector

Adds $form->isSubmitted() validatoin to all $form->isValid() calls in Form in Symfony

-if ($form->isValid()) {
+if ($form->isSubmitted() && $form->isValid()) {
 }

`OptionNameRector`

class: Rector\Symfony\Rector\Form\OptionNameRector

Turns old option names to new ones in FormTypes in Form in Symfony

 $builder = new FormBuilder;
-$builder->add("...", ["precision" => "...", "virtual" => "..."];
+$builder->add("...", ["scale" => "...", "inherit_data" => "..."];

`StringFormTypeToClassRector`

class: Rector\Symfony\Rector\Form\StringFormTypeToClassRector

Turns string Form Type references to their CONSTANT alternatives in FormTypes in Form in Symfony

 $formBuilder = new Symfony\Component\Form\FormBuilder;
-$formBuilder->add('name', 'form.type.text');
+$form->add('name', \Symfony\Component\Form\Extension\Core\Type\TextType::class);

`FormTypeGetParentRector`

class: Rector\Symfony\Rector\Form\FormTypeGetParentRector

Turns string Form Type references to their CONSTANT alternatives in getParent() and getExtendedType() methods in Form in Symfony

-function getParent() { return "collection"; }
+function getParent() { return CollectionType::class; }

-function getExtendedType() { return "collection"; }
+function getExtendedType() { return CollectionType::class; }

Symfony\FrameworkBundle

`GetParameterToConstructorInjectionRector`

class: Rector\Symfony\Rector\FrameworkBundle\GetParameterToConstructorInjectionRector

Turns fetching of parameters via getParameter() in ContainerAware to constructor injection in Command and Controller in Symfony

-class MyCommand extends ContainerAwareCommand
+class MyCommand extends Command
 {
+    private $someParameter;
+
+    public function __construct($someParameter)
+    {
+        $this->someParameter = $someParameter;
+    }
+
     public function someMethod()
     {
-        $this->getParameter('someParameter');
+        $this->someParameter;
     }
 }

`GetToConstructorInjectionRector`

class: Rector\Symfony\Rector\FrameworkBundle\GetToConstructorInjectionRector

Turns fetching of dependencies via $this->get() to constructor injection in Command and Controller in Symfony

-class MyCommand extends ContainerAwareCommand
+class MyCommand extends Command
 {
+    public function __construct(SomeService $someService)
+    {
+        $this->someService = $someService;
+    }
+
     public function someMethod()
     {
-        // ...
-        $this->get('some_service');
+        $this->someService;
     }
 }

`ContainerGetToConstructorInjectionRector`

class: Rector\Symfony\Rector\FrameworkBundle\ContainerGetToConstructorInjectionRector

Turns fetching of dependencies via $container->get() in ContainerAware to constructor injection in Command and Controller in Symfony

-final class SomeCommand extends ContainerAwareCommand
+final class SomeCommand extends Command
 {
+    public function __construct(SomeService $someService)
+    {
+        $this->someService = $someService;
+    }
+
     public function someMethod()
     {
         // ...
-        $this->getContainer()->get('some_service');
-        $this->container->get('some_service');
+        $this->someService;
+        $this->someService;
     }
 }

Symfony\HttpKernel

`GetRequestRector`

class: Rector\Symfony\Rector\HttpKernel\GetRequestRector

Turns fetching of dependencies via $this->get() to constructor injection in Command and Controller in Symfony

+use Symfony\Component\HttpFoundation\Request;
+
 class SomeController
 {
-    public function someAction()
+    public action(Request $request)
     {
-        $this->getRequest()->...();
+        $request->...();
     }
 }

Symfony\MethodCall

`CascadeValidationFormBuilderRector`

class: Rector\Symfony\Rector\MethodCall\CascadeValidationFormBuilderRector

Change "cascade_validation" option to specific node attribute

 class SomeController
 {
     public function someMethod()
     {
-        $form = $this->createFormBuilder($article, ['cascade_validation' => true])
-            ->add('author', new AuthorType())
+        $form = $this->createFormBuilder($article)
+            ->add('author', new AuthorType(), [
+                'constraints' => new \Symfony\Component\Validator\Constraints\Valid(),
+            ])
             ->getForm();
     }

     protected function createFormBuilder()
     {
         return new FormBuilder();
     }
 }

`ReadOnlyOptionToAttributeRector`

class: Rector\Symfony\Rector\MethodCall\ReadOnlyOptionToAttributeRector

Change "read_only" option in form to attribute

 use Symfony\Component\Form\FormBuilderInterface;

 function buildForm(FormBuilderInterface $builder, array $options)
 {
-    $builder->add('cuid', TextType::class, ['read_only' => true]);
+    $builder->add('cuid', TextType::class, ['attr' => [read_only' => true]]);
 }

`FormTypeInstanceToClassConstRector`

class: Rector\Symfony\Rector\MethodCall\FormTypeInstanceToClassConstRector

Changes createForm(new FormType), add(new FormType) to ones with "FormType::class"

 class SomeController
 {
     public function action()
     {
-        $form = $this->createForm(new TeamType, $entity, [
+        $form = $this->createForm(TeamType::class, $entity, [
             'action' => $this->generateUrl('teams_update', ['id' => $entity->getId()]),
             'method' => 'PUT',
-        ]);
+        ));
     }
 }

Symfony\New_

`StringToArrayArgumentProcessRector`

class: Rector\Symfony\Rector\New_\StringToArrayArgumentProcessRector

Changes Process string argument to an array

 use Symfony\Component\Process\Process;
-$process = new Process('ls -l');
+$process = new Process(['ls', '-l']);

`RootNodeTreeBuilderRector`

class: Rector\Symfony\Rector\New_\RootNodeTreeBuilderRector

Changes Process string argument to an array

 use Symfony\Component\Config\Definition\Builder\TreeBuilder;

-$treeBuilder = new TreeBuilder();
-$rootNode = $treeBuilder->root('acme_root');
+$treeBuilder = new TreeBuilder('acme_root');
+$rootNode = $treeBuilder->getRootNode();
 $rootNode->someCall();

Symfony\Process

`ProcessBuilderGetProcessRector`

class: Rector\Symfony\Rector\Process\ProcessBuilderGetProcessRector

Removes $processBuilder->getProcess() calls to $processBuilder in Process in Symfony, because ProcessBuilder was removed. This is part of multi-step Rector and has very narrow focus.

 $processBuilder = new Symfony\Component\Process\ProcessBuilder;
-$process = $processBuilder->getProcess();
-$commamdLine = $processBuilder->getProcess()->getCommandLine();
+$process = $processBuilder;
+$commamdLine = $processBuilder->getCommandLine();

`ProcessBuilderInstanceRector`

class: Rector\Symfony\Rector\Process\ProcessBuilderInstanceRector

Turns ProcessBuilder::instance() to new ProcessBuilder in Process in Symfony. Part of multi-step Rector.

-$processBuilder = Symfony\Component\Process\ProcessBuilder::instance($args);
+$processBuilder = new Symfony\Component\Process\ProcessBuilder($args);

Symfony\Validator

`ConstraintUrlOptionRector`

class: Rector\Symfony\Rector\Validator\ConstraintUrlOptionRector

Turns true value to Url::CHECK_DNS_TYPE_ANY in Validator in Symfony.

-$constraint = new Url(["checkDNS" => true]);
+$constraint = new Url(["checkDNS" => Url::CHECK_DNS_TYPE_ANY]);

Symfony\VarDumper

`VarDumperTestTraitMethodArgsRector`

class: Rector\Symfony\Rector\VarDumper\VarDumperTestTraitMethodArgsRector

Adds new $format argument in VarDumperTestTrait->assertDumpEquals() in Validator in Symfony.

-$varDumperTestTrait->assertDumpEquals($dump, $data, $mesage = "");
+$varDumperTestTrait->assertDumpEquals($dump, $data, $context = null, $mesage = "");

-$varDumperTestTrait->assertDumpMatchesFormat($dump, $format, $mesage = "");
+$varDumperTestTrait->assertDumpMatchesFormat($dump, $format, $context = null,  $mesage = "");

Symfony\Yaml

`ParseFileRector`

class: Rector\Symfony\Rector\Yaml\ParseFileRector

session > use_strict_mode is true by default and can be removed

-session > use_strict_mode: true
+session:

Twig

`SimpleFunctionAndFilterRector`

class: Rector\Twig\Rector\SimpleFunctionAndFilterRector

Changes Twig_Function_Method to Twig_SimpleFunction calls in TwigExtension.

 class SomeExtension extends Twig_Extension
 {
     public function getFunctions()
     {
         return [
-            'is_mobile' => new Twig_Function_Method($this, 'isMobile'),
+             new Twig_SimpleFunction('is_mobile', [$this, 'isMobile']),
         ];
     }

-    public function getFilters()
+    public function getFilteres()
     {
         return [
-            'is_mobile' => new Twig_Filter_Method($this, 'isMobile'),
+             new Twig_SimpleFilter('is_mobile', [$this, 'isMobile']),
         ];
     }
 }

General

Annotation
Argument
Assign
Class_
Constant
DependencyInjection
Function_
Interface_
MagicDisclosure
MethodBody
MethodCall
Namespace_
Property
Psr4
RepositoryAsService
StaticCall
Typehint
Visibility

Annotation

`AnnotationReplacerRector`

class: Rector\Rector\Annotation\AnnotationReplacerRector

Turns defined annotations above properties and methods to their new values.

services:
    Rector\Rector\Annotation\AnnotationReplacerRector:
        PHPUnit\Framework\TestCase:
            test: scenario

↓

 class SomeTest extends PHPUnit\Framework\TestCase
 {
-    /**
-     * @test
+    /**
+     * @scenario
      */
     public function someMethod()
     {
     }
 }

Argument

`ArgumentAdderRector`

class: Rector\Rector\Argument\ArgumentAdderRector

This Rector adds new default arguments in calls of defined methods and class types.

services:
    Rector\Rector\Argument\ArgumentAdderRector:
        SomeExampleClass:
            someMethod:
                -
                    default_value: 'true'

↓

 $someObject = new SomeExampleClass;
-$someObject->someMethod();
+$someObject->someMethod(true);

services:
    Rector\Rector\Argument\ArgumentAdderRector:
        SomeExampleClass:
            someMethod:
                -
                    default_value: 'true'

↓

 class MyCustomClass extends SomeExampleClass
 {
-    public function someMethod()
+    public function someMethod($value = true)
     {
     }
 }

`ArgumentRemoverRector`

class: Rector\Rector\Argument\ArgumentRemoverRector

Removes defined arguments in defined methods and their calls.

services:
    Rector\Rector\Argument\ArgumentRemoverRector:
        ExampleClass:
            someMethod:
                -
                    value: 'true'

↓

 $someObject = new SomeClass;
-$someObject->someMethod(true);
+$someObject->someMethod();'

`ArgumentDefaultValueReplacerRector`

class: Rector\Rector\Argument\ArgumentDefaultValueReplacerRector

Replaces defined map of arguments in defined methods and their calls.

services:
    Rector\Rector\Argument\ArgumentDefaultValueReplacerRector:
        SomeExampleClass:
            someMethod:
                -
                    -
                        before: 'SomeClass::OLD_CONSTANT'
                        after: 'false'

↓

 $someObject = new SomeClass;
-$someObject->someMethod(SomeClass::OLD_CONSTANT);
+$someObject->someMethod(false);'

Assign

`PropertyAssignToMethodCallRector`

class: Rector\Rector\Assign\PropertyAssignToMethodCallRector

Turns property assign of specific type and property name to method call

services:
    Rector\Rector\Assign\PropertyAssignToMethodCallRector:
        $oldPropertiesToNewMethodCallsByType:
            SomeClass:
                oldPropertyName: oldProperty
                newMethodName: newMethodCall

↓

-$someObject = new SomeClass;
-$someObject->oldProperty = false;
+$someObject = new SomeClass;
+$someObject->newMethodCall(false);

Class_

`ClassReplacerRector`

class: Rector\Rector\Class_\ClassReplacerRector

Replaces defined classes by new ones.

services:
    Rector\Rector\Class_\ClassReplacerRector:
        SomeOldClass: SomeNewClass

↓

-use SomeOldClass;
+use SomeNewClass;

-function (SomeOldClass $someOldClass): SomeOldClass
+function (SomeNewClass $someOldClass): SomeNewClass
 {
-    if ($someOldClass instanceof SomeOldClass) {
-        return new SomeOldClass;
+    if ($someOldClass instanceof SomeNewClass) {
+        return new SomeNewClass;
     }
 }

`ParentClassToTraitsRector`

class: Rector\Rector\Class_\ParentClassToTraitsRector

Replaces parent class to specific traits

services:
    Rector\Rector\Class_\ParentClassToTraitsRector:
        Nette\Object:
            - Nette\SmartObject

↓

-class SomeClass extends Nette\Object
+class SomeClass
 {
+    use Nette\SmartObject;
 }

Constant

`RenameClassConstantsUseToStringsRector`

class: Rector\Rector\Constant\RenameClassConstantsUseToStringsRector

Replaces constant by value

services:
    Rector\Rector\Constant\RenameClassConstantsUseToStringsRector:
        Nette\Configurator:
            DEVELOPMENT: development
            PRODUCTION: production

↓

-$value === Nette\Configurator::DEVELOPMENT
+$value === "development"

`ClassConstantReplacerRector`

class: Rector\Rector\Constant\ClassConstantReplacerRector

Replaces defined class constants in their calls.

services:
    Rector\Rector\Constant\ClassConstantReplacerRector:
        SomeClass:
            OLD_CONSTANT: NEW_CONSTANT

↓

-$value = SomeClass::OLD_CONSTANT;
+$value = SomeClass::NEW_CONSTANT;

DependencyInjection

`AnnotatedPropertyInjectToConstructorInjectionRector`

class: Rector\Rector\Architecture\DependencyInjection\AnnotatedPropertyInjectToConstructorInjectionRector

Turns non-private properties with @annotation to private properties and constructor injection

services:
    Rector\Rector\Architecture\DependencyInjection\AnnotatedPropertyInjectToConstructorInjectionRector:
        $annotation: inject

↓

 /**
  * @var SomeService
- * @inject
  */
-public $someService;
+private $someService;
+
+public function __construct(SomeService $someService)
+{
+    $this->someService = $someService;
+}

`ReplaceVariableByPropertyFetchRector`

class: Rector\Rector\Architecture\DependencyInjection\ReplaceVariableByPropertyFetchRector

Turns variable in controller action to property fetch, as follow up to action injection variable to property change.

 final class SomeController
 {
     /**
      * @var ProductRepository
      */
     private $productRepository;

     public function __construct(ProductRepository $productRepository)
     {
         $this->productRepository = $productRepository;
     }

     public function default()
     {
-        $products = $productRepository->fetchAll();
+        $products = $this->productRepository->fetchAll();
     }
 }

`ActionInjectionToConstructorInjectionRector`

class: Rector\Rector\Architecture\DependencyInjection\ActionInjectionToConstructorInjectionRector

Turns action injection in Controllers to constructor injection

 final class SomeController
 {
-    public function default(ProductRepository $productRepository)
+    /**
+     * @var ProductRepository
+     */
+    private $productRepository;
+    public function __construct(ProductRepository $productRepository)
     {
-        $products = $productRepository->fetchAll();
+        $this->productRepository = $productRepository;
+    }
+
+    public function default()
+    {
+        $products = $this->productRepository->fetchAll();
     }
 }

Function_

`FunctionToMethodCallRector`

class: Rector\Rector\Function_\FunctionToMethodCallRector

Turns defined function calls to local method calls.

services:
    Rector\Rector\Function_\FunctionToMethodCallRector:
        view:
            - this
            - render

↓

-view("...", []);
+$this->render("...", []);

`FunctionToStaticCallRector`

class: Rector\Rector\Function_\FunctionToStaticCallRector

Turns defined function call to static method call.

services:
    Rector\Rector\Function_\FunctionToStaticCallRector:
        view:
            - SomeStaticClass
            - render

↓

-view("...", []);
+SomeClass::render("...", []);

`FunctionReplaceRector`

class: Rector\Rector\Function_\FunctionReplaceRector

Turns defined function call new one.

services:
    Rector\Rector\Function_\FunctionReplaceRector:
        view: Laravel\Templating\render

↓

-view("...", []);
+Laravel\Templating\render("...", []);

Interface_

`MergeInterfacesRector`

class: Rector\Rector\Interface_\MergeInterfacesRector

Merges old interface to a new one, that already has its methods

services:
    Rector\Rector\Interface_\MergeInterfacesRector:
        SomeOldInterface: SomeInterface

↓

-class SomeClass implements SomeInterface, SomeOldInterface
+class SomeClass implements SomeInterface
 {
 }

MagicDisclosure

`ToStringToMethodCallRector`

class: Rector\Rector\MagicDisclosure\ToStringToMethodCallRector

Turns defined code uses of "__toString()" method to specific method calls.

services:
    Rector\Rector\MagicDisclosure\ToStringToMethodCallRector:
        SomeObject: getPath

↓

 $someValue = new SomeObject;
-$result = (string) $someValue;
-$result = $someValue->__toString();
+$result = $someValue->getPath();
+$result = $someValue->getPath();

`GetAndSetToMethodCallRector`

class: Rector\Rector\MagicDisclosure\GetAndSetToMethodCallRector

Turns defined __get/__set to specific method calls.

services:
    Rector\Rector\MagicDisclosure\GetAndSetToMethodCallRector:
        SomeContainer:
            set: addService

↓

 $container = new SomeContainer;
-$container->someService = $someService;
+$container->setService("someService", $someService);

services:
    Rector\Rector\MagicDisclosure\GetAndSetToMethodCallRector:
        $typeToMethodCalls:
            SomeContainer:
                get: getService

↓

 $container = new SomeContainer;
-$someService = $container->someService;
+$someService = $container->getService("someService");

`UnsetAndIssetToMethodCallRector`

class: Rector\Rector\MagicDisclosure\UnsetAndIssetToMethodCallRector

Turns defined __isset/__unset calls to specific method calls.

services:
    Rector\Rector\MagicDisclosure\UnsetAndIssetToMethodCallRector:
        SomeContainer:
            isset: hasService

↓

 $container = new SomeContainer;
-isset($container["someKey"]);
+$container->hasService("someKey");

services:
    Rector\Rector\MagicDisclosure\UnsetAndIssetToMethodCallRector:
        SomeContainer:
            unset: removeService

↓

 $container = new SomeContainer;
-unset($container["someKey"]);
+$container->removeService("someKey");

MethodBody

`FluentReplaceRector`

class: Rector\Rector\MethodBody\FluentReplaceRector

Turns fluent interface calls to classic ones.

services:
    Rector\Rector\MethodBody\FluentReplaceRector:
        -
            - SomeExampleClass

↓

 $someClass = new SomeClass();
-$someClass->someFunction()
-            ->otherFunction();
+$someClass->someFunction();
+$someClass->otherFunction();

`NormalToFluentRector`

class: Rector\Rector\MethodBody\NormalToFluentRector

Turns fluent interface calls to classic ones.

services:
    Rector\Rector\MethodBody\NormalToFluentRector:
        SomeClass:
            - someFunction
            - otherFunction

↓

 $someObject = new SomeClass();
-$someObject->someFunction();
-$someObject->otherFunction();
+$someObject->someFunction()
+    ->otherFunction();

`ReturnThisRemoveRector`

class: Rector\Rector\MethodBody\ReturnThisRemoveRector

Removes "return $this;" from fluent interfaces for specified classes.

services:
    Rector\Rector\MethodBody\ReturnThisRemoveRector:
        -
            - SomeExampleClass

↓

 class SomeClass
 {
     public function someFunction()
     {
-        return $this;
     }

     public function otherFunction()
     {
-        return $this;
     }
 }

MethodCall

`MethodCallToAnotherMethodCallWithArgumentsRector`

class: Rector\Rector\MethodCall\MethodCallToAnotherMethodCallWithArgumentsRector

Turns old method call with specfici type to new one with arguments

services:
    Rector\Rector\MethodCall\MethodCallToAnotherMethodCallWithArgumentsRector:
        Nette\DI\ServiceDefinition:
            setInject:
                -
                    - addTag
                    -
                        - inject

↓

 $serviceDefinition = new Nette\DI\ServiceDefinition;
-$serviceDefinition->setInject();
+$serviceDefinition->addTag('inject');

`MethodNameReplacerRector`

class: Rector\Rector\MethodCall\MethodNameReplacerRector

Turns method names to new ones.

services:
    Rector\Rector\MethodCall\MethodNameReplacerRector:
        SomeExampleClass:
            oldMethod: newMethod

↓

 $someObject = new SomeExampleClass;
-$someObject->oldMethod();
+$someObject->newMethod();

`StaticMethodNameReplacerRector`

class: Rector\Rector\MethodCall\StaticMethodNameReplacerRector

Turns method names to new ones.

services:
    Rector\Rector\MethodCall\StaticMethodNameReplacerRector:
        SomeClass:
            oldMethod:
                - AnotherExampleClass
                - newStaticMethod

↓

-SomeClass::oldStaticMethod();
+AnotherExampleClass::newStaticMethod();

services:
    Rector\Rector\MethodCall\StaticMethodNameReplacerRector:
        $oldToNewMethodByClasses:
            SomeClass:
                oldMethod: newStaticMethod

↓

-SomeClass::oldStaticMethod();
+SomeClass::newStaticMethod();

Namespace_

`NamespaceReplacerRector`

class: Rector\Rector\Namespace_\NamespaceReplacerRector

Replaces old namespace by new one.

services:
    Rector\Rector\Namespace_\NamespaceReplacerRector:
        $oldToNewNamespaces:
            SomeOldNamespace: SomeNewNamespace

↓

-$someObject = new SomeOldNamespace\SomeClass;
+$someObject = new SomeNewNamespace\SomeClass;

`PseudoNamespaceToNamespaceRector`

class: Rector\Rector\Namespace_\PseudoNamespaceToNamespaceRector

Replaces defined Pseudo_Namespaces by Namespace\Ones.

services:
    Rector\Rector\Namespace_\PseudoNamespaceToNamespaceRector:
        -
            Some_: {  }

↓

-$someService = new Some_Object;
+$someService = new Some\Object;

services:
    Rector\Rector\Namespace_\PseudoNamespaceToNamespaceRector:
        -
            Some_:
                - Some_Class_To_Keep

↓

-$someService = new Some_Object;
+$someService = new Some\Object;
 $someClassToKeep = new Some_Class_To_Keep;

Property

`PropertyToMethodRector`

class: Rector\Rector\Property\PropertyToMethodRector

Replaces properties assign calls be defined methods.

services:
    Rector\Rector\Property\PropertyToMethodRector:
        $perClassPropertyToMethods:
            SomeObject:
                property:
                    get: getProperty
                    set: setProperty

↓

-$result = $object->property;
-$object->property = $value;
+$result = $object->getProperty();
+$object->setProperty($value);

services:
    Rector\Rector\Property\PropertyToMethodRector:
        $perClassPropertyToMethods:
            SomeObject:
                property:
                    get:
                        method: getConfig
                        arguments:
                            - someArg

↓

-$result = $object->property;
+$result = $object->getProperty('someArg');

`PropertyNameReplacerRector`

class: Rector\Rector\Property\PropertyNameReplacerRector

Replaces defined old properties by new ones.

services:
    Rector\Rector\Property\PropertyNameReplacerRector:
        $oldToNewPropertyByTypes:
            SomeClass:
                someOldProperty: someNewProperty

↓

-$someObject->someOldProperty;
+$someObject->someNewProperty;

Psr4

`MultipleClassFileToPsr4ClassesRector`

class: Rector\Rector\Psr4\MultipleClassFileToPsr4ClassesRector

Turns namespaced classes in one file to standalone PSR-4 classes.

+// new file: "app/Exceptions/FirstException.php"
 namespace App\Exceptions;

 use Exception;

 final class FirstException extends Exception
 {

 }
+
+// new file: "app/Exceptions/SecondException.php"
+namespace App\Exceptions;
+
+use Exception;

 final class SecondException extends Exception
 {

 }

RepositoryAsService

`ReplaceParentRepositoryCallsByRepositoryPropertyRector`

class: Rector\Rector\Architecture\RepositoryAsService\ReplaceParentRepositoryCallsByRepositoryPropertyRector

Handles method calls in child of Doctrine EntityRepository and moves them to "$this->repository" property.

 <?php

 use Doctrine\ORM\EntityRepository;

 class SomeRepository extends EntityRepository
 {
     public function someMethod()
     {
-        return $this->findAll();
+        return $this->repository->findAll();
     }
 }

`ServiceLocatorToDIRector`

class: Rector\Rector\Architecture\RepositoryAsService\ServiceLocatorToDIRector

Turns "$this->getRepository()" in Symfony Controller to constructor injection and private property access.

 class ProductController extends Controller
 {
+    /**
+     * @var ProductRepository
+     */
+    private $productRepository;
+
+    public function __construct(ProductRepository $productRepository)
+    {
+        $this->productRepository = $productRepository;
+    }
+
     public function someAction()
     {
         $entityManager = $this->getDoctrine()->getManager();
-        $entityManager->getRepository('SomethingBundle:Product')->findSomething(...);
+        $this->productRepository->findSomething(...);
     }
 }

`MoveRepositoryFromParentToConstructorRector`

class: Rector\Rector\Architecture\RepositoryAsService\MoveRepositoryFromParentToConstructorRector

Turns parent EntityRepository class to constructor dependency

services:
    Rector\Rector\Architecture\RepositoryAsService\MoveRepositoryFromParentToConstructorRector:
        $entityRepositoryClass: Doctrine\ORM\EntityRepository
        $entityManagerClass: Doctrine\ORM\EntityManager

↓

 namespace App\Repository;

+use App\Entity\Post;
 use Doctrine\ORM\EntityRepository;

-final class PostRepository extends EntityRepository
+final class PostRepository
 {
+    /**
+     * @var \Doctrine\ORM\EntityRepository
+     */
+    private $repository;
+    public function __construct(\Doctrine\ORM\EntityManager $entityManager)
+    {
+        $this->repository = $entityManager->getRepository(\App\Entity\Post::class);
+    }
 }

StaticCall

`StaticCallToFunctionRector`

class: Rector\Rector\StaticCall\StaticCallToFunctionRector

Turns static call to function call.

services:
    Rector\Rector\StaticCall\StaticCallToFunctionRector:
        $staticCallToFunction:
            OldClass:
                oldMethod: new_function

↓

-OldClass::oldMethod("args");
+new_function("args");

Typehint

`ReturnTypehintRector`

class: Rector\Rector\Typehint\ReturnTypehintRector

Changes defined return typehint of method and class.

services:
    Rector\Rector\Typehint\ReturnTypehintRector:
        $typehintForMethodByClass:
            SomeClass:
                getData: array

↓

 class SomeClass
 {
-    public getData();
+    public getData(): array;
 }

`ParentTypehintedArgumentRector`

class: Rector\Rector\Typehint\ParentTypehintedArgumentRector

Changes defined parent class typehints.

services:
    Rector\Rector\Typehint\ParentTypehintedArgumentRector:
        SomeInterface:
            read:
                $content: string

↓

 interface SomeInterface
 {
     public read(string $content);
 }

 class SomeClass implements SomeInterface
 {
-    public read($content);
+    public read(string $content);
 }

Visibility

`ChangeMethodVisibilityRector`

class: Rector\Rector\Visibility\ChangeMethodVisibilityRector

Change visibility of method from parent class.

services:
    Rector\Rector\Visibility\ChangeMethodVisibilityRector:
        FrameworkClass:
            someMethod: protected

↓

 class FrameworkClass
 {
     protected someMethod()
     {
     }
 }

 class MyClass extends FrameworkClass
 {
-    public someMethod()
+    protected someMethod()
     {
     }
 }

`ChangePropertyVisibilityRector`

class: Rector\Rector\Visibility\ChangePropertyVisibilityRector

Change visibility of property from parent class.

services:
    Rector\Rector\Visibility\ChangePropertyVisibilityRector:
        FrameworkClass:
            someProperty: protected

↓

 class FrameworkClass
 {
     protected $someProperty;
 }

 class MyClass extends FrameworkClass
 {
-    public $someProperty;
+    protected $someProperty;
 }

`ChangeConstantVisibilityRector`

class: Rector\Rector\Visibility\ChangeConstantVisibilityRector

Change visibility of constant from parent class.

services:
    Rector\Rector\Visibility\ChangeConstantVisibilityRector:
        ParentObject:
            SOME_CONSTANT: protected

↓

 class FrameworkClass
 {
     protected const SOME_CONSTANT = 1;
 }

 class MyClass extends FrameworkClass
 {
-    public const SOME_CONSTANT = 1;
+    protected const SOME_CONSTANT = 1;
 }

64 KiB Raw Blame History

All Rectors Overview

Projects

CakePHP\MethodCall

ModalToGetSetRector

CodeQuality\Assign

CombinedAssignRector

CodeQuality\BooleanAnd

SimplifyEmptyArrayCheckRector

CodeQuality\Expression

SimplifyMirrorAssignRector

CodeQuality\Foreach_

ForeachToInArrayRector

SimplifyForeachToCoalescingRector

CodeQuality\FuncCall

InArrayAndArrayKeysToArrayKeyExistsRector

SimplifyInArrayValuesRector

SimplifyFuncGetArgsCountRector

SimplifyStrposLowerRector