2024-01-16 10:21:57 +00:00
# 354 Rules Overview
2020-11-27 13:00:56 +01:00
< br >
2020-02-13 14:42:40 +01:00
2020-11-25 22:34:34 +01:00
## Categories
2020-02-13 14:42:40 +01:00
2023-08-28 12:45:54 +00:00
- [Arguments ](#arguments ) (4)
2021-02-21 00:21:19 +01:00
2023-12-04 14:56:20 +00:00
- [CodeQuality ](#codequality ) (73)
2020-02-13 14:42:40 +01:00
2023-12-26 17:40:03 +00:00
- [CodingStyle ](#codingstyle ) (28)
2020-02-13 14:42:40 +01:00
2024-01-02 21:38:33 +00:00
- [DeadCode ](#deadcode ) (42)
2021-01-01 19:59:23 +01:00
2023-07-11 15:52:31 +00:00
- [EarlyReturn ](#earlyreturn ) (9)
2019-09-15 20:28:10 +02:00
2024-01-23 11:08:03 +00:00
- [Instanceof ](#instanceof ) (1)
2023-08-06 00:29:06 +00:00
2021-08-01 00:25:55 +00:00
- [Naming ](#naming ) (6)
2020-09-24 20:54:39 +02:00
2020-11-25 22:34:34 +01:00
- [Php52 ](#php52 ) (2)
2021-10-28 22:22:07 +00:00
- [Php53 ](#php53 ) (3)
2020-11-25 22:34:34 +01:00
2022-07-03 11:40:45 +00:00
- [Php54 ](#php54 ) (3)
2020-11-25 22:34:34 +01:00
2023-04-19 07:12:58 +00:00
- [Php55 ](#php55 ) (6)
2020-11-25 22:34:34 +01:00
2023-08-09 10:56:45 +00:00
- [Php56 ](#php56 ) (1)
2020-11-25 22:34:34 +01:00
2023-05-17 09:47:50 +00:00
- [Php70 ](#php70 ) (19)
2020-11-25 22:34:34 +01:00
2023-12-04 14:56:20 +00:00
- [Php71 ](#php71 ) (7)
2020-11-25 22:34:34 +01:00
2023-05-26 13:14:15 +00:00
- [Php72 ](#php72 ) (9)
2020-11-25 22:34:34 +01:00
2021-02-07 11:11:42 +01:00
- [Php73 ](#php73 ) (9)
2020-11-25 22:34:34 +01:00
2023-11-07 18:56:36 +00:00
- [Php74 ](#php74 ) (12)
2020-11-25 22:34:34 +01:00
2023-07-09 00:38:42 +00:00
- [Php80 ](#php80 ) (16)
2020-11-25 22:34:34 +01:00
2023-08-14 06:41:08 +00:00
- [Php81 ](#php81 ) (9)
2021-05-16 08:19:51 +00:00
2023-06-26 18:55:49 +00:00
- [Php82 ](#php82 ) (4)
2022-05-15 09:42:33 +00:00
2023-12-30 11:58:36 +00:00
- [Php83 ](#php83 ) (3)
2023-11-03 12:13:20 +00:00
2024-01-16 10:21:57 +00:00
- [Privatization ](#privatization ) (4)
2020-11-25 22:34:34 +01:00
2023-08-06 16:40:47 +00:00
- [Removing ](#removing ) (5)
2021-01-30 21:30:37 +01:00
2023-09-09 11:18:54 +00:00
- [Renaming ](#renaming ) (9)
2020-11-25 22:34:34 +01:00
2023-06-08 18:28:01 +00:00
- [Strict ](#strict ) (5)
2021-10-05 08:51:30 +00:00
2023-06-08 23:27:12 +00:00
- [Transform ](#transform ) (22)
2020-11-25 22:34:34 +01:00
2023-12-10 00:29:28 +00:00
- [TypeDeclaration ](#typedeclaration ) (40)
2020-09-11 11:21:48 +02:00
2022-04-10 00:31:45 +00:00
- [Visibility ](#visibility ) (3)
2020-09-24 20:54:39 +02:00
2020-11-16 17:50:38 +00:00
< br >
2020-09-11 11:21:48 +02:00
2021-02-21 00:21:19 +01:00
## Arguments
### ArgumentAdderRector
This Rector adds new default arguments in calls of defined methods and class types.
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\Arguments\Rector\ClassMethod\ArgumentAdderRector` ](../rules/Arguments/Rector/ClassMethod/ArgumentAdderRector.php )
2021-02-21 00:21:19 +01:00
```diff
$someObject = new SomeExampleClass;
-$someObject->someMethod();
+$someObject->someMethod(true);
class MyCustomClass extends SomeExampleClass
{
- public function someMethod()
+ public function someMethod($value = true)
{
}
}
```
< br >
2021-06-13 10:00:46 +00:00
### FunctionArgumentDefaultValueReplacerRector
2021-02-21 00:21:19 +01:00
2021-06-13 10:00:46 +00:00
Streamline the operator arguments of version_compare function
2021-02-21 00:21:19 +01:00
:wrench: **configure it!**
2021-06-13 10:00:46 +00:00
- class: [`Rector\Arguments\Rector\FuncCall\FunctionArgumentDefaultValueReplacerRector` ](../rules/Arguments/Rector/FuncCall/FunctionArgumentDefaultValueReplacerRector.php )
2021-02-21 00:21:19 +01:00
```diff
2021-06-13 10:00:46 +00:00
-version_compare(PHP_VERSION, '5.6', 'gte');
+version_compare(PHP_VERSION, '5.6', 'ge');
2021-02-21 00:21:19 +01:00
```
< br >
2023-06-16 14:39:03 +00:00
### RemoveMethodCallParamRector
Remove parameter of method call
:wrench: **configure it!**
- class: [`Rector\Arguments\Rector\MethodCall\RemoveMethodCallParamRector` ](../rules/Arguments/Rector/MethodCall/RemoveMethodCallParamRector.php )
```diff
final class SomeClass
{
public function run(Caller $caller)
{
- $caller->process(1, 2);
+ $caller->process(1);
}
}
```
< br >
2021-06-13 10:00:46 +00:00
### ReplaceArgumentDefaultValueRector
2021-05-23 09:33:26 +00:00
2021-06-13 10:00:46 +00:00
Replaces defined map of arguments in defined methods and their calls.
2021-05-23 09:33:26 +00:00
:wrench: **configure it!**
2021-06-13 10:00:46 +00:00
- class: [`Rector\Arguments\Rector\ClassMethod\ReplaceArgumentDefaultValueRector` ](../rules/Arguments/Rector/ClassMethod/ReplaceArgumentDefaultValueRector.php )
2021-05-23 09:33:26 +00:00
```diff
2021-06-13 10:00:46 +00:00
$someObject = new SomeClass;
-$someObject->someMethod(SomeClass::OLD_CONSTANT);
2021-08-01 00:25:55 +00:00
+$someObject->someMethod(false);
2021-05-23 09:33:26 +00:00
```
< br >
2020-11-25 22:34:34 +01:00
## CodeQuality
### AbsolutizeRequireAndIncludePathRector
2022-01-16 09:58:52 +00:00
include/require to absolute path. This Rector might introduce backwards incompatible code, when the include/require being changed depends on the current working directory.
2020-11-25 22:34:34 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Include_\AbsolutizeRequireAndIncludePathRector` ](../rules/CodeQuality/Rector/Include_/AbsolutizeRequireAndIncludePathRector.php )
2020-11-25 22:34:34 +01:00
```diff
class SomeClass
2020-11-16 17:50:38 +00:00
{
public function run()
{
2020-11-25 22:34:34 +01:00
- require 'autoload.php';
+ require __DIR__ . '/autoload.php';
require $variable;
2020-01-03 19:20:13 +01:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-01-03 19:20:13 +01:00
2020-11-25 22:34:34 +01:00
### AndAssignsToSeparateLinesRector
2019-03-09 13:24:30 +00:00
2020-11-25 22:34:34 +01:00
Split 2 assigns ands to separate line
2019-05-29 15:40:20 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\LogicalAnd\AndAssignsToSeparateLinesRector` ](../rules/CodeQuality/Rector/LogicalAnd/AndAssignsToSeparateLinesRector.php )
2019-03-09 13:24:30 +00:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2019-03-09 13:24:30 +00:00
{
2020-11-25 22:34:34 +01:00
public function run()
2019-03-09 13:24:30 +00:00
{
2020-11-25 22:34:34 +01:00
$tokens = [];
- $token = 4 and $tokens[] = $token;
+ $token = 4;
+ $tokens[] = $token;
2019-03-09 13:24:30 +00:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2019-03-09 13:24:30 +00:00
2020-11-25 22:34:34 +01:00
### ArrayKeyExistsTernaryThenValueToCoalescingRector
2020-01-03 19:20:13 +01:00
2022-01-16 09:58:52 +00:00
Change `array_key_exists()` ternary to coalescing
2020-01-03 19:20:13 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Ternary\ArrayKeyExistsTernaryThenValueToCoalescingRector` ](../rules/CodeQuality/Rector/Ternary/ArrayKeyExistsTernaryThenValueToCoalescingRector.php )
2020-01-03 19:20:13 +01:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2020-01-03 19:20:13 +01:00
{
2020-11-25 22:34:34 +01:00
public function run($values, $keyToMatch)
2020-01-03 19:20:13 +01:00
{
2020-11-25 22:34:34 +01:00
- $result = array_key_exists($keyToMatch, $values) ? $values[$keyToMatch] : null;
+ $result = $values[$keyToMatch] ?? null;
2020-01-03 19:20:13 +01:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-01-03 19:20:13 +01:00
2020-11-25 22:34:34 +01:00
### ArrayMergeOfNonArraysToSimpleArrayRector
2019-11-07 00:52:19 +01:00
2021-04-10 20:18:49 +02:00
Change array_merge of non arrays to array directly
2019-11-07 00:52:19 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\FuncCall\ArrayMergeOfNonArraysToSimpleArrayRector` ](../rules/CodeQuality/Rector/FuncCall/ArrayMergeOfNonArraysToSimpleArrayRector.php )
2019-11-07 00:52:19 +01:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
{
public function go()
{
$value = 5;
$value2 = 10;
2019-11-07 00:52:19 +01:00
2020-11-25 22:34:34 +01:00
- return array_merge([$value], [$value2]);
+ return [$value, $value2];
}
}
2019-11-07 00:52:19 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-11-07 00:52:19 +01:00
2020-11-25 22:34:34 +01:00
### BooleanNotIdenticalToNotIdenticalRector
2018-12-22 12:22:28 +01:00
2020-11-25 22:34:34 +01:00
Negated identical boolean compare to not identical compare (does not apply to non-bool values)
2018-12-22 12:22:28 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Identical\BooleanNotIdenticalToNotIdenticalRector` ](../rules/CodeQuality/Rector/Identical/BooleanNotIdenticalToNotIdenticalRector.php )
2019-06-02 10:45:37 +03:00
2020-11-25 22:34:34 +01:00
```diff
class SomeClass
{
public function run()
{
$a = true;
$b = false;
2018-12-22 12:22:28 +01:00
2020-11-25 22:34:34 +01:00
- var_dump(! $a === $b); // true
- var_dump(! ($a === $b)); // true
+ var_dump($a !== $b); // true
+ var_dump($a !== $b); // true
var_dump($a !== $b); // true
}
}
```
2018-12-22 12:22:28 +01:00
2020-11-25 22:34:34 +01:00
< br >
2018-12-31 12:50:32 +01:00
2022-09-25 00:37:30 +00:00
### BoolvalToTypeCastRector
Change `boolval()` to faster and readable (bool) `$value`
- class: [`Rector\CodeQuality\Rector\FuncCall\BoolvalToTypeCastRector` ](../rules/CodeQuality/Rector/FuncCall/BoolvalToTypeCastRector.php )
```diff
class SomeClass
{
public function run($value)
{
- return boolval($value);
+ return (bool) $value;
}
}
```
< br >
2021-05-09 02:15:50 +02:00
### CallUserFuncWithArrowFunctionToInlineRector
Refactor `call_user_func()` with arrow function to direct call
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\FuncCall\CallUserFuncWithArrowFunctionToInlineRector` ](../rules/CodeQuality/Rector/FuncCall/CallUserFuncWithArrowFunctionToInlineRector.php )
2021-05-09 02:15:50 +02:00
```diff
final class SomeClass
{
public function run()
{
- $result = \call_user_func(fn () => 100);
+ $result = 100;
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### CallableThisArrayToAnonymousFunctionRector
2018-12-31 12:50:32 +01:00
2020-11-25 22:34:34 +01:00
Convert [$this, "method"] to proper anonymous function
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Array_\CallableThisArrayToAnonymousFunctionRector` ](../rules/CodeQuality/Rector/Array_/CallableThisArrayToAnonymousFunctionRector.php )
2018-12-31 12:50:32 +01:00
```diff
2019-06-02 10:45:37 +03:00
class SomeClass
{
2020-11-25 22:34:34 +01:00
public function run()
{
$values = [1, 5, 3];
- usort($values, [$this, 'compareSize']);
+ usort($values, function ($first, $second) {
+ return $this->compareSize($first, $second);
+ });
return $values;
}
private function compareSize($first, $second)
2019-06-02 10:45:37 +03:00
{
2020-11-25 22:34:34 +01:00
return $first < => $second;
2019-06-02 10:45:37 +03:00
}
}
2018-12-31 12:50:32 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-12-31 12:50:32 +01:00
2020-11-25 22:34:34 +01:00
### ChangeArrayPushToArrayAssignRector
2020-01-04 00:31:17 +01:00
2020-11-25 22:34:34 +01:00
Change `array_push()` to direct variable assign
2020-01-04 00:31:17 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\FuncCall\ChangeArrayPushToArrayAssignRector` ](../rules/CodeQuality/Rector/FuncCall/ChangeArrayPushToArrayAssignRector.php )
2020-01-04 00:31:17 +01:00
```diff
2022-05-10 16:14:43 +00:00
$items = [];
-array_push($items, $item);
+$items[] = $item;
2020-01-04 00:31:17 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-01-04 00:31:17 +01:00
2023-05-08 10:34:06 +00:00
### CleanupUnneededNullsafeOperatorRector
Cleanup unneeded nullsafe operator
- class: [`Rector\CodeQuality\Rector\NullsafeMethodCall\CleanupUnneededNullsafeOperatorRector` ](../rules/CodeQuality/Rector/NullsafeMethodCall/CleanupUnneededNullsafeOperatorRector.php )
```diff
class HelloWorld {
public function getString(): string
{
return 'hello world';
}
}
function get(): HelloWorld
{
return new HelloWorld();
}
-echo get()?->getString();
+echo get()->getString();
```
< br >
2020-11-25 22:34:34 +01:00
### CombineIfRector
2020-01-15 21:40:44 +01:00
2020-11-25 22:34:34 +01:00
Merges nested if statements
2020-01-15 21:40:44 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\If_\CombineIfRector` ](../rules/CodeQuality/Rector/If_/CombineIfRector.php )
2020-01-15 21:40:44 +01:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
{
public function run()
{
- if ($cond1) {
- if ($cond2) {
- return 'foo';
- }
+ if ($cond1 & & $cond2) {
+ return 'foo';
}
}
}
2020-01-15 21:40:44 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-01-15 21:40:44 +01:00
2020-11-25 22:34:34 +01:00
### CombinedAssignRector
2018-10-22 00:26:45 +02:00
2020-11-25 22:34:34 +01:00
Simplify `$value` = `$value` + 5; assignments to shorter ones
2018-10-22 00:26:45 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Assign\CombinedAssignRector` ](../rules/CodeQuality/Rector/Assign/CombinedAssignRector.php )
2018-10-22 00:26:45 +02:00
2020-11-25 22:34:34 +01:00
```diff
-$value = $value + 5;
+$value += 5;
```
2018-10-22 00:26:45 +02:00
2020-11-25 22:34:34 +01:00
< br >
2018-11-11 13:22:35 +01:00
2020-11-25 22:34:34 +01:00
### CommonNotEqualRector
2020-07-27 10:16:16 +02:00
2020-11-25 22:34:34 +01:00
Use common != instead of less known < > with same meaning
2020-07-27 10:16:16 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\NotEqual\CommonNotEqualRector` ](../rules/CodeQuality/Rector/NotEqual/CommonNotEqualRector.php )
2020-07-27 10:16:16 +02:00
```diff
2020-11-25 22:34:34 +01:00
final class SomeClass
2020-07-27 10:16:16 +02:00
{
2020-11-25 22:34:34 +01:00
public function run($one, $two)
{
- return $one < > $two;
+ return $one != $two;
}
2020-07-27 10:16:16 +02:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-07-27 10:16:16 +02:00
2020-11-25 22:34:34 +01:00
### CompactToVariablesRector
2019-05-02 01:56:58 +02:00
2020-11-25 22:34:34 +01:00
Change `compact()` call to own array
2019-05-02 01:56:58 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\FuncCall\CompactToVariablesRector` ](../rules/CodeQuality/Rector/FuncCall/CompactToVariablesRector.php )
2019-05-29 15:40:20 +02:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2019-06-02 10:45:37 +03:00
{
2020-11-25 22:34:34 +01:00
public function run()
2019-06-02 10:45:37 +03:00
{
2020-11-25 22:34:34 +01:00
$checkout = 'one';
$form = 'two';
- return compact('checkout', 'form');
+ return ['checkout' => $checkout, 'form' => $form];
2019-06-02 10:45:37 +03:00
}
}
2019-05-29 15:40:20 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-05-29 15:40:20 +02:00
2020-11-25 22:34:34 +01:00
### CompleteDynamicPropertiesRector
2019-05-29 15:40:20 +02:00
2020-11-25 22:34:34 +01:00
Add missing dynamic properties
2019-05-29 15:40:20 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Class_\CompleteDynamicPropertiesRector` ](../rules/CodeQuality/Rector/Class_/CompleteDynamicPropertiesRector.php )
2019-06-02 10:45:37 +03:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2019-06-02 10:45:37 +03:00
{
2020-11-25 22:34:34 +01:00
+ /**
+ * @var int
+ */
+ public $value;
2021-04-10 20:18:49 +02:00
+
2020-11-25 22:34:34 +01:00
public function set()
2019-06-02 10:45:37 +03:00
{
2020-11-25 22:34:34 +01:00
$this->value = 5;
2019-06-02 10:45:37 +03:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2019-06-02 10:45:37 +03:00
2023-10-05 14:38:05 +00:00
### CompleteMissingIfElseBracketRector
Complete missing if/else brackets
- class: [`Rector\CodeQuality\Rector\If_\CompleteMissingIfElseBracketRector` ](../rules/CodeQuality/Rector/If_/CompleteMissingIfElseBracketRector.php )
```diff
class SomeClass
{
public function run($value)
{
- if ($value)
+ if ($value) {
return 1;
+ }
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### ConsecutiveNullCompareReturnsToNullCoalesceQueueRector
2019-06-02 10:45:37 +03:00
2020-11-25 22:34:34 +01:00
Change multiple null compares to ?? queue
2019-06-02 10:45:37 +03:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\If_\ConsecutiveNullCompareReturnsToNullCoalesceQueueRector` ](../rules/CodeQuality/Rector/If_/ConsecutiveNullCompareReturnsToNullCoalesceQueueRector.php )
2019-05-02 01:56:58 +02:00
```diff
class SomeClass
{
2020-11-25 22:34:34 +01:00
public function run()
2019-05-02 01:56:58 +02:00
{
2023-05-10 06:07:59 +00:00
- if ($this->orderItem !== null) {
2020-11-25 22:34:34 +01:00
- return $this->orderItem;
- }
-
2023-05-10 06:07:59 +00:00
- if ($this->orderItemUnit !== null) {
2020-11-25 22:34:34 +01:00
- return $this->orderItemUnit;
- }
-
- return null;
+ return $this->orderItem ?? $this->orderItemUnit;
2019-05-02 01:56:58 +02:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2022-12-12 12:29:16 +00:00
### ConvertStaticPrivateConstantToSelfRector
2022-12-17 08:33:16 +00:00
Replaces static::* access to private constants with self::*
2022-12-12 12:29:16 +00:00
- class: [`Rector\CodeQuality\Rector\ClassConstFetch\ConvertStaticPrivateConstantToSelfRector` ](../rules/CodeQuality/Rector/ClassConstFetch/ConvertStaticPrivateConstantToSelfRector.php )
```diff
2023-06-08 18:28:01 +00:00
final class Foo
{
2022-12-12 12:29:16 +00:00
private const BAR = 'bar';
2023-06-08 18:28:01 +00:00
2022-12-12 12:29:16 +00:00
public function run()
{
- $bar = static::BAR;
+ $bar = self::BAR;
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### ExplicitBoolCompareRector
2020-11-16 17:50:38 +00:00
2020-11-25 22:34:34 +01:00
Make if conditions more explicit
2020-11-16 17:50:38 +00:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\If_\ExplicitBoolCompareRector` ](../rules/CodeQuality/Rector/If_/ExplicitBoolCompareRector.php )
2019-05-19 10:27:38 +02:00
```diff
2020-11-25 22:34:34 +01:00
final class SomeController
2019-05-19 10:27:38 +02:00
{
2020-11-25 22:34:34 +01:00
public function run($items)
2019-05-19 10:27:38 +02:00
{
2020-11-25 22:34:34 +01:00
- if (!count($items)) {
+ if (count($items) === 0) {
return 'no items';
}
2019-05-19 10:27:38 +02:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2019-05-19 10:27:38 +02:00
2021-01-24 10:07:23 +01:00
### FlipTypeControlToUseExclusiveTypeRector
2023-04-30 00:41:21 +00:00
Flip type control from null compare to use exclusive instanceof object
2021-01-24 10:07:23 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Identical\FlipTypeControlToUseExclusiveTypeRector` ](../rules/CodeQuality/Rector/Identical/FlipTypeControlToUseExclusiveTypeRector.php )
2021-01-24 10:07:23 +01:00
```diff
2023-03-26 00:33:56 +00:00
function process(?DateTime $dateTime)
{
- if ($dateTime === null) {
+ if (! $dateTime instanceof DateTime) {
return;
}
2021-01-24 10:07:23 +01:00
}
```
< br >
2022-09-25 00:37:30 +00:00
### FloatvalToTypeCastRector
Change `floatval()` and `doubleval()` to faster and readable (float) `$value`
- class: [`Rector\CodeQuality\Rector\FuncCall\FloatvalToTypeCastRector` ](../rules/CodeQuality/Rector/FuncCall/FloatvalToTypeCastRector.php )
```diff
class SomeClass
{
public function run($value)
{
- $a = floatval($value);
- $b = doubleval($value);
+ $a = (float) $value;
+ $b = (float) $value;
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### ForRepeatedCountToOwnVariableRector
2020-01-04 18:49:26 +01:00
2020-11-25 22:34:34 +01:00
Change `count()` in for function to own variable
2020-01-04 18:49:26 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\For_\ForRepeatedCountToOwnVariableRector` ](../rules/CodeQuality/Rector/For_/ForRepeatedCountToOwnVariableRector.php )
2020-01-04 18:49:26 +01:00
2020-11-25 22:34:34 +01:00
```diff
class SomeClass
{
public function run($items)
{
- for ($i = 5; $i < = count($items); $i++) {
+ $itemsCount = count($items);
+ for ($i = 5; $i < = $itemsCount; $i++) {
echo $items[$i];
}
}
}
```
2020-01-04 18:49:26 +01:00
2020-11-25 22:34:34 +01:00
< br >
2020-01-04 18:49:26 +01:00
2020-11-25 22:34:34 +01:00
### ForeachItemsAssignToEmptyArrayToAssignRector
2020-01-04 18:49:26 +01:00
2020-11-25 22:34:34 +01:00
Change `foreach()` items assign to empty array to direct assign
2020-01-04 18:49:26 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Foreach_\ForeachItemsAssignToEmptyArrayToAssignRector` ](../rules/CodeQuality/Rector/Foreach_/ForeachItemsAssignToEmptyArrayToAssignRector.php )
2020-01-04 18:49:26 +01:00
```diff
class SomeClass
{
2020-11-25 22:34:34 +01:00
public function run($items)
{
$collectedItems = [];
- foreach ($items as $item) {
- $collectedItems[] = $item;
- }
+ $collectedItems = $items;
}
2020-01-04 18:49:26 +01:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-01-04 18:49:26 +01:00
2020-11-25 22:34:34 +01:00
### ForeachToInArrayRector
2018-10-22 00:26:45 +02:00
2020-11-25 22:34:34 +01:00
Simplify `foreach` loops into `in_array` when possible
2018-10-22 00:26:45 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Foreach_\ForeachToInArrayRector` ](../rules/CodeQuality/Rector/Foreach_/ForeachToInArrayRector.php )
2018-10-22 00:26:45 +02:00
```diff
2020-11-25 22:34:34 +01:00
-foreach ($items as $item) {
- if ($item === 'something') {
- return true;
- }
-}
-
-return false;
2021-02-21 00:02:05 +01:00
+return in_array('something', $items, true);
2020-11-25 22:34:34 +01:00
```
2020-11-16 17:50:38 +00:00
2020-11-25 22:34:34 +01:00
< br >
2020-11-16 17:50:38 +00:00
2020-11-25 22:34:34 +01:00
### GetClassToInstanceOfRector
2020-11-16 17:50:38 +00:00
2021-04-10 20:18:49 +02:00
Changes comparison with get_class to instanceof
2020-11-25 22:34:34 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Identical\GetClassToInstanceOfRector` ](../rules/CodeQuality/Rector/Identical/GetClassToInstanceOfRector.php )
2020-11-25 22:34:34 +01:00
```diff
-if (EventsListener::class === get_class($event->job)) { }
+if ($event->job instanceof EventsListener) { }
2018-10-22 00:26:45 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-10-23 17:13:13 -03:00
2022-04-28 14:55:01 +00:00
### InlineArrayReturnAssignRector
Inline just in time array dim fetch assigns to direct return
- class: [`Rector\CodeQuality\Rector\ClassMethod\InlineArrayReturnAssignRector` ](../rules/CodeQuality/Rector/ClassMethod/InlineArrayReturnAssignRector.php )
```diff
function getPerson()
{
- $person = [];
- $person['name'] = 'Timmy';
- $person['surname'] = 'Back';
-
- return $person;
+ return [
+ 'name' => 'Timmy',
+ 'surname' => 'Back',
+ ];
}
```
< br >
2022-03-15 17:33:16 +00:00
### InlineConstructorDefaultToPropertyRector
Move property default from constructor to property default
- class: [`Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector` ](../rules/CodeQuality/Rector/Class_/InlineConstructorDefaultToPropertyRector.php )
```diff
final class SomeClass
{
- private $name;
+ private $name = 'John';
2022-11-02 00:04:20 +00:00
public function __construct()
{
- $this->name = 'John';
}
2022-03-15 17:33:16 +00:00
}
```
< br >
2020-11-25 22:34:34 +01:00
### InlineIfToExplicitIfRector
2019-05-19 10:27:38 +02:00
2020-11-25 22:34:34 +01:00
Change inline if to explicit if
2019-05-19 10:27:38 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Expression\InlineIfToExplicitIfRector` ](../rules/CodeQuality/Rector/Expression/InlineIfToExplicitIfRector.php )
2019-05-19 10:27:38 +02:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2020-11-16 17:50:38 +00:00
{
2020-11-25 22:34:34 +01:00
public function run()
{
$userId = null;
- is_null($userId) && $userId = 5;
+ if (is_null($userId)) {
+ $userId = 5;
+ }
}
2020-11-16 17:50:38 +00:00
}
2019-06-02 10:45:37 +03:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-06-02 10:45:37 +03:00
2022-05-29 00:36:37 +00:00
### InlineIsAInstanceOfRector
Change `is_a()` with object and class name check to instanceof
- class: [`Rector\CodeQuality\Rector\FuncCall\InlineIsAInstanceOfRector` ](../rules/CodeQuality/Rector/FuncCall/InlineIsAInstanceOfRector.php )
```diff
class SomeClass
{
public function run(object $object)
{
- return is_a($object, SomeType::class);
+ return $object instanceof SomeType;
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### IntvalToTypeCastRector
2020-02-22 13:05:45 +01:00
2020-11-25 22:34:34 +01:00
Change `intval()` to faster and readable (int) `$value`
2020-02-22 13:05:45 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\FuncCall\IntvalToTypeCastRector` ](../rules/CodeQuality/Rector/FuncCall/IntvalToTypeCastRector.php )
2020-02-22 13:05:45 +01:00
```diff
class SomeClass
{
2020-11-25 22:34:34 +01:00
public function run($value)
2020-02-22 13:05:45 +01:00
{
2020-11-25 22:34:34 +01:00
- return intval($value);
+ return (int) $value;
2020-02-22 13:05:45 +01:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-02-22 13:05:45 +01:00
2020-11-25 22:34:34 +01:00
### IsAWithStringWithThirdArgumentRector
2019-12-27 18:50:00 +01:00
2020-11-25 22:34:34 +01:00
Complete missing 3rd argument in case `is_a()` function in case of strings
2019-12-27 18:50:00 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\FuncCall\IsAWithStringWithThirdArgumentRector` ](../rules/CodeQuality/Rector/FuncCall/IsAWithStringWithThirdArgumentRector.php )
2019-12-27 18:50:00 +01:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2019-12-27 18:50:00 +01:00
{
2020-11-25 22:34:34 +01:00
public function __construct(string $value)
2019-12-27 18:50:00 +01:00
{
2020-11-25 22:34:34 +01:00
- return is_a($value, 'stdClass');
+ return is_a($value, 'stdClass', true);
2019-12-27 18:50:00 +01:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2019-12-27 18:50:00 +01:00
2020-11-25 22:34:34 +01:00
### IssetOnPropertyObjectToPropertyExistsRector
2019-08-05 23:10:47 +02:00
2021-02-21 00:02:05 +01:00
Change isset on property object to `property_exists()` and not null check
2019-08-05 23:10:47 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Isset_\IssetOnPropertyObjectToPropertyExistsRector` ](../rules/CodeQuality/Rector/Isset_/IssetOnPropertyObjectToPropertyExistsRector.php )
2020-06-16 13:39:38 +02:00
2019-08-05 23:10:47 +02:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
{
private $x;
public function run(): void
{
- isset($this->x);
+ property_exists($this, 'x') & & $this->x !== null;
}
}
2019-08-05 23:10:47 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-08-05 23:10:47 +02:00
2020-11-25 22:34:34 +01:00
### JoinStringConcatRector
2020-09-15 19:30:36 +07:00
2021-01-05 21:06:16 +01:00
Joins concat of 2 strings, unless the length is too long
2020-09-15 19:30:36 +07:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Concat\JoinStringConcatRector` ](../rules/CodeQuality/Rector/Concat/JoinStringConcatRector.php )
2020-09-15 19:30:36 +07:00
```diff
class SomeClass
{
2020-11-25 22:34:34 +01:00
public function run()
{
- $name = 'Hi' . ' Tom';
+ $name = 'Hi Tom';
}
2020-09-15 19:30:36 +07:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-09-15 19:30:36 +07:00
2023-06-16 14:09:13 +00:00
### LocallyCalledStaticMethodToNonStaticRector
Change static method and local-only calls to non-static
- class: [`Rector\CodeQuality\Rector\ClassMethod\LocallyCalledStaticMethodToNonStaticRector` ](../rules/CodeQuality/Rector/ClassMethod/LocallyCalledStaticMethodToNonStaticRector.php )
```diff
class SomeClass
{
public function run()
{
- self::someStatic();
+ $this->someStatic();
}
- private static function someStatic()
+ private function someStatic()
{
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### LogicalToBooleanRector
2019-06-02 10:45:37 +03:00
2020-11-25 22:34:34 +01:00
Change OR, AND to ||, & & with more common understanding
2019-06-02 10:45:37 +03:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\LogicalAnd\LogicalToBooleanRector` ](../rules/CodeQuality/Rector/LogicalAnd/LogicalToBooleanRector.php )
2019-06-02 10:45:37 +03:00
```diff
2020-11-25 22:34:34 +01:00
-if ($f = false or true) {
+if (($f = false) || true) {
return $f;
}
2019-05-19 10:27:38 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-05-19 10:27:38 +02:00
2020-11-25 22:34:34 +01:00
### NewStaticToNewSelfRector
2020-10-21 00:01:47 +02:00
2020-11-25 22:34:34 +01:00
Change unsafe new `static()` to new `self()`
2020-11-16 17:50:38 +00:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\New_\NewStaticToNewSelfRector` ](../rules/CodeQuality/Rector/New_/NewStaticToNewSelfRector.php )
2020-10-21 00:01:47 +02:00
```diff
2023-06-08 23:27:12 +00:00
final class SomeClass
2020-10-21 00:01:47 +02:00
{
2020-11-25 22:34:34 +01:00
public function build()
2020-10-21 00:01:47 +02:00
{
2020-11-25 22:34:34 +01:00
- return new static();
+ return new self();
2020-10-21 00:01:47 +02:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-10-21 00:01:47 +02:00
2023-09-05 13:21:31 +00:00
### NumberCompareToMaxFuncCallRector
Ternary number compare to `max()` call
- class: [`Rector\CodeQuality\Rector\Ternary\NumberCompareToMaxFuncCallRector` ](../rules/CodeQuality/Rector/Ternary/NumberCompareToMaxFuncCallRector.php )
```diff
class SomeClass
{
public function run($value)
{
- return $value > 100 ? $value : 100;
+ return max($value, 100);
}
}
```
< br >
2022-02-15 22:46:36 +00:00
### OptionalParametersAfterRequiredRector
Move required parameters after optional ones
- class: [`Rector\CodeQuality\Rector\ClassMethod\OptionalParametersAfterRequiredRector` ](../rules/CodeQuality/Rector/ClassMethod/OptionalParametersAfterRequiredRector.php )
```diff
class SomeObject
{
- public function run($optional = 1, $required)
+ public function run($required, $optional = 1)
{
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### RemoveSoleValueSprintfRector
Remove `sprintf()` wrapper if not needed
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\FuncCall\RemoveSoleValueSprintfRector` ](../rules/CodeQuality/Rector/FuncCall/RemoveSoleValueSprintfRector.php )
2019-08-05 23:10:47 +02:00
2020-11-16 17:50:38 +00:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
{
public function run()
{
$welcome = 'hello';
- $value = sprintf('%s', $welcome);
+ $value = $welcome;
}
}
2020-11-16 17:50:38 +00:00
```
2019-09-28 00:34:34 +02:00
2020-11-16 17:50:38 +00:00
< br >
2019-09-28 00:34:34 +02:00
2023-12-04 14:56:20 +00:00
### RemoveUselessIsObjectCheckRector
Remove useless `is_object()` check on combine with instanceof check
- class: [`Rector\CodeQuality\Rector\BooleanAnd\RemoveUselessIsObjectCheckRector` ](../rules/CodeQuality/Rector/BooleanAnd/RemoveUselessIsObjectCheckRector.php )
```diff
-is_object($obj) & & $obj instanceof DateTime
+$obj instanceof DateTime
```
< br >
2021-11-28 00:36:13 +00:00
### ReplaceMultipleBooleanNotRector
Replace the Double not operator (!!) by type-casting to boolean
- class: [`Rector\CodeQuality\Rector\BooleanNot\ReplaceMultipleBooleanNotRector` ](../rules/CodeQuality/Rector/BooleanNot/ReplaceMultipleBooleanNotRector.php )
```diff
-$bool = !!$var;
+$bool = (bool) $var;
```
< br >
2020-11-25 22:34:34 +01:00
### SetTypeToCastRector
2019-09-28 00:34:34 +02:00
2020-11-25 22:34:34 +01:00
Changes `settype()` to (type) where possible
2019-09-28 00:34:34 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\FuncCall\SetTypeToCastRector` ](../rules/CodeQuality/Rector/FuncCall/SetTypeToCastRector.php )
2019-09-28 00:34:34 +02:00
2020-11-25 22:34:34 +01:00
```diff
class SomeClass
{
2021-08-01 00:25:55 +00:00
public function run($foo)
2020-11-25 22:34:34 +01:00
{
- settype($foo, 'string');
+ $foo = (string) $foo;
2020-07-27 10:16:16 +02:00
2020-11-25 22:34:34 +01:00
- return settype($foo, 'integer');
+ return (int) $foo;
}
}
2020-11-16 17:50:38 +00:00
```
2020-11-25 22:34:34 +01:00
< br >
### ShortenElseIfRector
Shortens else/if to elseif
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\If_\ShortenElseIfRector` ](../rules/CodeQuality/Rector/If_/ShortenElseIfRector.php )
2020-07-27 10:16:16 +02:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2020-07-27 10:16:16 +02:00
{
2020-11-25 22:34:34 +01:00
public function run()
2020-07-27 10:16:16 +02:00
{
2020-11-25 22:34:34 +01:00
if ($cond1) {
return $action1;
- } else {
- if ($cond2) {
- return $action2;
- }
+ } elseif ($cond2) {
+ return $action2;
}
2020-07-27 10:16:16 +02:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-07-27 10:16:16 +02:00
2020-11-25 22:34:34 +01:00
### SimplifyArraySearchRector
2019-10-04 19:31:37 +02:00
2021-04-10 20:18:49 +02:00
Simplify array_search to in_array
2019-10-04 19:31:37 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Identical\SimplifyArraySearchRector` ](../rules/CodeQuality/Rector/Identical/SimplifyArraySearchRector.php )
2018-11-11 13:22:35 +01:00
2020-11-25 22:34:34 +01:00
```diff
-array_search("searching", $array) !== false;
+in_array("searching", $array);
2020-11-16 17:50:38 +00:00
```
2018-11-11 13:22:35 +01:00
2020-11-25 22:34:34 +01:00
< br >
2018-11-11 13:22:35 +01:00
```diff
2020-11-25 22:34:34 +01:00
-array_search("searching", $array, true) !== false;
+in_array("searching", $array, true);
2018-11-11 13:22:35 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-11-11 13:22:35 +01:00
2020-11-25 22:34:34 +01:00
### SimplifyBoolIdenticalTrueRector
2018-12-31 12:50:32 +01:00
2022-01-16 09:58:52 +00:00
Simplify bool value compare to true or false
2018-12-31 12:50:32 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Identical\SimplifyBoolIdenticalTrueRector` ](../rules/CodeQuality/Rector/Identical/SimplifyBoolIdenticalTrueRector.php )
2018-12-31 12:50:32 +01:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2018-12-31 12:50:32 +01:00
{
2020-11-25 22:34:34 +01:00
public function run(bool $value, string $items)
2019-05-29 15:40:20 +02:00
{
2020-11-25 22:34:34 +01:00
- $match = in_array($value, $items, TRUE) === TRUE;
+ $match = in_array($value, $items, TRUE);
2023-09-05 13:21:31 +00:00
- $match = in_array($value, $items, TRUE) !== FALSE;
2020-11-25 22:34:34 +01:00
+ $match = in_array($value, $items, TRUE);
2018-12-31 12:50:32 +01:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2018-12-31 12:50:32 +01:00
2020-11-25 22:34:34 +01:00
### SimplifyConditionsRector
2018-10-22 00:26:45 +02:00
2020-11-25 22:34:34 +01:00
Simplify conditions
2018-10-22 00:26:45 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Identical\SimplifyConditionsRector` ](../rules/CodeQuality/Rector/Identical/SimplifyConditionsRector.php )
2018-10-22 00:26:45 +02:00
```diff
2020-11-25 22:34:34 +01:00
-if (! ($foo !== 'bar')) {...
+if ($foo === 'bar') {...
2020-11-16 17:50:38 +00:00
```
2019-06-02 10:45:37 +03:00
2020-11-16 17:50:38 +00:00
< br >
2019-06-02 10:45:37 +03:00
2020-11-25 22:34:34 +01:00
### SimplifyDeMorganBinaryRector
2019-06-02 10:45:37 +03:00
2020-11-25 22:34:34 +01:00
Simplify negated conditions with de Morgan theorem
2019-06-02 10:45:37 +03:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\BooleanNot\SimplifyDeMorganBinaryRector` ](../rules/CodeQuality/Rector/BooleanNot/SimplifyDeMorganBinaryRector.php )
2019-06-02 10:45:37 +03:00
2020-11-25 22:34:34 +01:00
```diff
$a = 5;
$b = 10;
-$result = !($a > 20 || $b < = 50);
+$result = $a < = 20 & & $b > 50;
```
2018-10-22 00:26:45 +02:00
2020-11-25 22:34:34 +01:00
< br >
2019-03-31 14:25:39 +02:00
2020-11-25 22:34:34 +01:00
### SimplifyEmptyArrayCheckRector
2018-11-11 13:22:35 +01:00
2020-11-25 22:34:34 +01:00
Simplify `is_array` and `empty` functions combination into a simple identical check for an empty array
2018-11-11 13:22:35 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\BooleanAnd\SimplifyEmptyArrayCheckRector` ](../rules/CodeQuality/Rector/BooleanAnd/SimplifyEmptyArrayCheckRector.php )
2018-10-22 00:26:45 +02:00
```diff
2020-11-25 22:34:34 +01:00
-is_array($values) & & empty($values)
+$values === []
2018-10-22 00:26:45 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-10-22 00:26:45 +02:00
2022-11-16 15:33:33 +00:00
### SimplifyEmptyCheckOnEmptyArrayRector
2023-05-10 07:10:45 +00:00
Simplify `empty()` functions calls on empty arrays
2022-11-16 15:33:33 +00:00
- class: [`Rector\CodeQuality\Rector\Empty_\SimplifyEmptyCheckOnEmptyArrayRector` ](../rules/CodeQuality/Rector/Empty_/SimplifyEmptyCheckOnEmptyArrayRector.php )
```diff
2023-05-10 07:10:45 +00:00
$array = [];
-if (empty($values)) {
+if ([] === $values) {
}
2022-11-16 15:33:33 +00:00
```
< br >
2020-11-25 22:34:34 +01:00
### SimplifyForeachToCoalescingRector
2019-05-29 15:40:20 +02:00
2020-11-25 22:34:34 +01:00
Changes foreach that returns set value to ??
2019-05-29 15:40:20 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Foreach_\SimplifyForeachToCoalescingRector` ](../rules/CodeQuality/Rector/Foreach_/SimplifyForeachToCoalescingRector.php )
2019-05-29 15:40:20 +02:00
```diff
2020-11-25 22:34:34 +01:00
-foreach ($this->oldToNewFunctions as $oldFunction => $newFunction) {
- if ($currentFunction === $oldFunction) {
2023-12-02 05:05:22 +00:00
- return $newFunction;
2020-11-25 22:34:34 +01:00
- }
-}
-
2023-12-02 05:05:22 +00:00
-return null;
+return $this->oldToNewFunctions[$currentFunction] ?? null;
2019-02-18 16:51:24 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-06-02 10:45:37 +03:00
2020-11-25 22:34:34 +01:00
### SimplifyFuncGetArgsCountRector
2021-04-10 20:18:49 +02:00
Simplify count of `func_get_args()` to `func_num_args()`
2020-11-25 22:34:34 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\FuncCall\SimplifyFuncGetArgsCountRector` ](../rules/CodeQuality/Rector/FuncCall/SimplifyFuncGetArgsCountRector.php )
2020-11-25 22:34:34 +01:00
2019-06-02 10:45:37 +03:00
```diff
2020-11-25 22:34:34 +01:00
-count(func_get_args());
+func_num_args();
2019-06-02 10:45:37 +03:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-06-02 10:45:37 +03:00
2020-11-25 22:34:34 +01:00
### SimplifyIfElseToTernaryRector
2019-06-02 10:45:37 +03:00
2020-11-25 22:34:34 +01:00
Changes if/else for same value as assign to ternary
2019-06-02 10:45:37 +03:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\If_\SimplifyIfElseToTernaryRector` ](../rules/CodeQuality/Rector/If_/SimplifyIfElseToTernaryRector.php )
2018-12-31 12:50:32 +01:00
```diff
class SomeClass
{
2020-11-25 22:34:34 +01:00
public function run()
2018-12-31 12:50:32 +01:00
{
2020-11-25 22:34:34 +01:00
- if (empty($value)) {
- $this->arrayBuilt[][$key] = true;
- } else {
- $this->arrayBuilt[][$key] = $value;
- }
+ $this->arrayBuilt[][$key] = empty($value) ? true : $value;
2018-12-31 12:50:32 +01:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2018-12-31 12:50:32 +01:00
2020-11-25 22:34:34 +01:00
### SimplifyIfNotNullReturnRector
2019-02-18 16:51:24 +01:00
2020-11-25 22:34:34 +01:00
Changes redundant null check to instant return
2019-02-18 16:51:24 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\If_\SimplifyIfNotNullReturnRector` ](../rules/CodeQuality/Rector/If_/SimplifyIfNotNullReturnRector.php )
2019-02-18 16:51:24 +01:00
```diff
2021-07-22 18:40:24 +00:00
$newNode = 'something';
2020-11-25 22:34:34 +01:00
-if ($newNode !== null) {
- return $newNode;
-}
-
-return null;
+return $newNode;
2019-02-18 16:51:24 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-02-18 16:51:24 +01:00
2021-04-10 20:18:49 +02:00
### SimplifyIfNullableReturnRector
Direct return on if nullable check before return
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\If_\SimplifyIfNullableReturnRector` ](../rules/CodeQuality/Rector/If_/SimplifyIfNullableReturnRector.php )
2021-04-10 20:18:49 +02:00
```diff
class SomeClass
{
public function run()
{
2023-09-17 06:58:27 +00:00
- $value = $this->get();
2021-04-10 20:18:49 +02:00
- if (! $value instanceof \stdClass) {
- return null;
- }
-
- return $value;
2023-09-17 06:58:27 +00:00
+ return $this->get();
}
public function get(): ?stdClass {
2021-04-10 20:18:49 +02:00
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### SimplifyIfReturnBoolRector
2019-01-22 21:34:38 +01:00
2020-11-25 22:34:34 +01:00
Shortens if return false/true to direct return
2019-01-22 21:34:38 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\If_\SimplifyIfReturnBoolRector` ](../rules/CodeQuality/Rector/If_/SimplifyIfReturnBoolRector.php )
2019-01-22 21:34:38 +01:00
```diff
2020-11-25 22:34:34 +01:00
-if (strpos($docToken->getContent(), "\n") === false) {
- return true;
-}
-
-return false;
+return strpos($docToken->getContent(), "\n") === false;
2019-01-22 21:34:38 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-01-22 21:34:38 +01:00
2020-11-25 22:34:34 +01:00
### SimplifyInArrayValuesRector
2019-05-19 10:27:38 +02:00
2020-11-25 22:34:34 +01:00
Removes unneeded `array_values()` in `in_array()` call
2019-05-29 15:40:20 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\FuncCall\SimplifyInArrayValuesRector` ](../rules/CodeQuality/Rector/FuncCall/SimplifyInArrayValuesRector.php )
2019-05-19 10:27:38 +02:00
```diff
2020-11-25 22:34:34 +01:00
-in_array("key", array_values($array), true);
+in_array("key", $array, true);
2019-05-19 10:27:38 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-05-19 10:27:38 +02:00
2020-11-25 22:34:34 +01:00
### SimplifyRegexPatternRector
2019-02-04 01:32:53 +01:00
2020-11-25 22:34:34 +01:00
Simplify regex pattern to known ranges
2019-02-04 01:32:53 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\FuncCall\SimplifyRegexPatternRector` ](../rules/CodeQuality/Rector/FuncCall/SimplifyRegexPatternRector.php )
2019-02-04 01:32:53 +01:00
```diff
2020-11-16 17:50:38 +00:00
class SomeClass
{
2020-11-25 22:34:34 +01:00
public function run($value)
2020-11-16 17:50:38 +00:00
{
2020-11-25 22:34:34 +01:00
- preg_match('#[a-zA-Z0-9+]#', $value);
+ preg_match('#[\w\d+]#', $value);
2020-11-16 17:50:38 +00:00
}
}
2019-05-29 15:40:20 +02:00
```
2019-02-04 01:32:53 +01:00
2020-11-16 17:50:38 +00:00
< br >
2018-12-22 12:22:28 +01:00
2020-11-25 22:34:34 +01:00
### SimplifyStrposLowerRector
2018-12-22 12:22:28 +01:00
2021-01-09 12:16:22 +01:00
Simplify `strpos(strtolower()` , "...") calls
2018-12-22 12:22:28 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\FuncCall\SimplifyStrposLowerRector` ](../rules/CodeQuality/Rector/FuncCall/SimplifyStrposLowerRector.php )
2018-12-22 12:22:28 +01:00
```diff
2021-07-22 18:40:24 +00:00
-strpos(strtolower($var), "...")
+stripos($var, "...")
2018-12-22 12:22:28 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-10-23 15:58:57 -03:00
2020-11-25 22:34:34 +01:00
### SimplifyTautologyTernaryRector
Simplify tautology ternary to value
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Ternary\SimplifyTautologyTernaryRector` ](../rules/CodeQuality/Rector/Ternary/SimplifyTautologyTernaryRector.php )
2020-11-25 22:34:34 +01:00
2018-10-23 15:58:57 -03:00
```diff
2020-11-25 22:34:34 +01:00
-$value = ($fullyQualifiedTypeHint !== $typeHint) ? $fullyQualifiedTypeHint : $typeHint;
+$value = $fullyQualifiedTypeHint;
2018-10-23 15:58:57 -03:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-10-22 00:26:45 +02:00
2020-11-25 22:34:34 +01:00
### SimplifyUselessVariableRector
2019-05-02 01:56:58 +02:00
2020-11-25 22:34:34 +01:00
Removes useless variable assigns
2019-05-02 01:56:58 +02:00
2022-04-10 18:18:46 +00:00
- class: [`Rector\CodeQuality\Rector\FunctionLike\SimplifyUselessVariableRector` ](../rules/CodeQuality/Rector/FunctionLike/SimplifyUselessVariableRector.php )
2019-05-02 01:56:58 +02:00
```diff
2020-11-25 22:34:34 +01:00
function () {
- $a = true;
- return $a;
+ return true;
};
2019-05-02 01:56:58 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-04-19 15:54:00 +02:00
2020-11-25 22:34:34 +01:00
### SingleInArrayToCompareRector
Changes `in_array()` with single element to ===
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\FuncCall\SingleInArrayToCompareRector` ](../rules/CodeQuality/Rector/FuncCall/SingleInArrayToCompareRector.php )
2020-11-25 22:34:34 +01:00
2020-04-19 15:54:00 +02:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
{
public function run()
{
- if (in_array(strtolower($type), ['$this'], true)) {
+ if (strtolower($type) === '$this') {
return strtolower($type);
}
}
}
2020-04-19 15:54:00 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-04-19 15:54:00 +02:00
2021-01-25 19:59:06 +01:00
### SingularSwitchToIfRector
Change switch with only 1 check to if
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Switch_\SingularSwitchToIfRector` ](../rules/CodeQuality/Rector/Switch_/SingularSwitchToIfRector.php )
2021-01-25 19:59:06 +01:00
```diff
class SomeObject
{
public function run($value)
{
$result = 1;
- switch ($value) {
- case 100:
+ if ($value === 100) {
$result = 1000;
}
return $result;
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### StrlenZeroToIdenticalEmptyStringRector
2019-08-05 23:10:47 +02:00
2021-04-10 20:18:49 +02:00
Changes strlen comparison to 0 to direct empty string compare
2019-08-05 23:10:47 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Identical\StrlenZeroToIdenticalEmptyStringRector` ](../rules/CodeQuality/Rector/Identical/StrlenZeroToIdenticalEmptyStringRector.php )
2019-08-05 23:10:47 +02:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
{
2021-10-14 15:36:34 +00:00
public function run(string $value)
2020-11-25 22:34:34 +01:00
{
- $empty = strlen($value) === 0;
+ $empty = $value === '';
}
}
2019-08-05 23:10:47 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-12-25 20:55:16 +01:00
2022-09-25 00:37:30 +00:00
### StrvalToTypeCastRector
Change `strval()` to faster and readable (string) `$value`
- class: [`Rector\CodeQuality\Rector\FuncCall\StrvalToTypeCastRector` ](../rules/CodeQuality/Rector/FuncCall/StrvalToTypeCastRector.php )
```diff
class SomeClass
{
public function run($value)
{
- return strval($value);
+ return (string) $value;
}
}
```
< br >
2021-01-01 19:59:23 +01:00
### SwitchNegatedTernaryRector
Switch negated ternary condition rector
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Ternary\SwitchNegatedTernaryRector` ](../rules/CodeQuality/Rector/Ternary/SwitchNegatedTernaryRector.php )
2021-01-01 19:59:23 +01:00
```diff
class SomeClass
{
public function run(bool $upper, string $name)
{
- return ! $upper
- ? $name
- : strtoupper($name);
+ return $upper
+ ? strtoupper($name)
+ : $name;
}
}
```
< br >
2023-04-02 00:33:26 +00:00
### SwitchTrueToIfRector
Change switch (true) to if statements
- class: [`Rector\CodeQuality\Rector\Switch_\SwitchTrueToIfRector` ](../rules/CodeQuality/Rector/Switch_/SwitchTrueToIfRector.php )
```diff
class SomeClass
{
public function run()
{
- switch (true) {
- case $value === 0:
- return 'no';
- case $value === 1:
- return 'yes';
- case $value === 2:
- return 'maybe';
- };
+ if ($value === 0) {
+ return 'no';
+ }
+
+ if ($value === 1) {
+ return 'yes';
+ }
+
+ if ($value === 2) {
+ return 'maybe';
+ }
}
}
```
< br >
2022-11-01 19:57:56 +00:00
### TernaryEmptyArrayArrayDimFetchToCoalesceRector
Change ternary empty on array property with array dim fetch to coalesce operator
- class: [`Rector\CodeQuality\Rector\Ternary\TernaryEmptyArrayArrayDimFetchToCoalesceRector` ](../rules/CodeQuality/Rector/Ternary/TernaryEmptyArrayArrayDimFetchToCoalesceRector.php )
```diff
final class SomeClass
{
private array $items = [];
public function run()
{
- return ! empty($this->items) ? $this->items[0] : 'default';
+ return $this->items[0] ?? 'default';
}
}
```
< br >
2022-06-29 16:03:56 +00:00
### TernaryFalseExpressionToIfRector
Change ternary with false to if and explicit call
- class: [`Rector\CodeQuality\Rector\Expression\TernaryFalseExpressionToIfRector` ](../rules/CodeQuality/Rector/Expression/TernaryFalseExpressionToIfRector.php )
```diff
final class SomeClass
{
public function run($value, $someMethod)
{
- $value ? $someMethod->call($value) : false;
+ if ($value) {
+ $someMethod->call($value);
+ }
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### ThrowWithPreviousExceptionRector
When throwing into a catch block, checks that the previous exception is passed to the new throw clause
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Catch_\ThrowWithPreviousExceptionRector` ](../rules/CodeQuality/Rector/Catch_/ThrowWithPreviousExceptionRector.php )
2020-11-25 22:34:34 +01:00
2018-11-11 13:22:35 +01:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
{
public function run()
{
try {
$someCode = 1;
} catch (Throwable $throwable) {
- throw new AnotherException('ups');
+ throw new AnotherException('ups', $throwable->getCode(), $throwable);
}
}
}
2018-11-11 13:22:35 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-11-11 13:22:35 +01:00
2020-11-25 22:34:34 +01:00
### UnnecessaryTernaryExpressionRector
2020-04-24 19:03:14 +02:00
2022-04-10 19:50:50 +00:00
Remove unnecessary ternary expressions
2020-04-24 19:03:14 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Ternary\UnnecessaryTernaryExpressionRector` ](../rules/CodeQuality/Rector/Ternary/UnnecessaryTernaryExpressionRector.php )
2020-04-24 19:03:14 +02:00
```diff
2020-11-25 22:34:34 +01:00
-$foo === $bar ? true : false;
+$foo === $bar;
2020-11-16 17:50:38 +00:00
```
< br >
2020-11-25 22:34:34 +01:00
### UnusedForeachValueToArrayKeysRector
Change foreach with unused `$value` but only `$key,` to `array_keys()`
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Foreach_\UnusedForeachValueToArrayKeysRector` ](../rules/CodeQuality/Rector/Foreach_/UnusedForeachValueToArrayKeysRector.php )
2020-11-25 22:34:34 +01:00
2020-11-16 17:50:38 +00:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
{
public function run()
{
$items = [];
- foreach ($values as $key => $value) {
+ foreach (array_keys($values) as $key) {
$items[$key] = null;
}
}
}
2020-04-24 19:03:14 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-04-24 19:03:14 +02:00
2020-12-22 16:48:25 +01:00
### UnwrapSprintfOneArgumentRector
unwrap `sprintf()` with one argument
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\FuncCall\UnwrapSprintfOneArgumentRector` ](../rules/CodeQuality/Rector/FuncCall/UnwrapSprintfOneArgumentRector.php )
2020-12-22 16:48:25 +01:00
```diff
-echo sprintf('value');
+echo 'value';
```
< br >
2020-11-25 22:34:34 +01:00
### UseIdenticalOverEqualWithSameTypeRector
2018-12-22 15:15:11 +01:00
2020-11-25 22:34:34 +01:00
Use ===/!== over ==/!=, it values have the same type
2018-12-22 15:15:11 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodeQuality\Rector\Equal\UseIdenticalOverEqualWithSameTypeRector` ](../rules/CodeQuality/Rector/Equal/UseIdenticalOverEqualWithSameTypeRector.php )
2018-12-22 15:15:11 +01:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
{
public function run(int $firstValue, int $secondValue)
{
- $isSame = $firstValue == $secondValue;
- $isDiffernt = $firstValue != $secondValue;
+ $isSame = $firstValue === $secondValue;
+ $isDiffernt = $firstValue !== $secondValue;
}
}
2020-11-16 17:50:38 +00:00
```
2019-05-29 15:40:20 +02:00
2020-11-16 17:50:38 +00:00
< br >
2020-11-25 22:34:34 +01:00
## CodingStyle
2019-05-26 21:26:33 +02:00
2023-11-07 18:56:36 +00:00
### ArraySpreadInsteadOfArrayMergeRector
Change `array_merge()` to spread operator
- class: [`Rector\CodingStyle\Rector\FuncCall\ArraySpreadInsteadOfArrayMergeRector` ](../rules/CodingStyle/Rector/FuncCall/ArraySpreadInsteadOfArrayMergeRector.php )
```diff
class SomeClass
{
public function run($iter1, $iter2)
{
- $values = array_merge(iterator_to_array($iter1), iterator_to_array($iter2));
+ $values = [...$iter1, ...$iter2];
// Or to generalize to all iterables
- $anotherValues = array_merge(
- is_array($iter1) ? $iter1 : iterator_to_array($iter1),
- is_array($iter2) ? $iter2 : iterator_to_array($iter2)
- );
+ $anotherValues = [...$iter1, ...$iter2];
}
}
```
< br >
2021-05-09 02:15:50 +02:00
### CallUserFuncArrayToVariadicRector
2020-02-21 02:06:13 +01:00
2021-05-09 02:15:50 +02:00
Replace `call_user_func_array()` with variadic
2020-02-21 02:06:13 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\FuncCall\CallUserFuncArrayToVariadicRector` ](../rules/CodingStyle/Rector/FuncCall/CallUserFuncArrayToVariadicRector.php )
2020-02-21 02:06:13 +01:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
{
public function run()
{
- call_user_func_array('some_function', $items);
+ some_function(...$items);
}
}
2020-02-21 02:06:13 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-02-21 02:06:13 +01:00
2021-05-09 02:15:50 +02:00
### CallUserFuncToMethodCallRector
Refactor `call_user_func()` on known class method to a method call
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\FuncCall\CallUserFuncToMethodCallRector` ](../rules/CodingStyle/Rector/FuncCall/CallUserFuncToMethodCallRector.php )
2021-05-09 02:15:50 +02:00
```diff
final class SomeClass
{
public function run()
{
- $result = \call_user_func([$this->property, 'method'], $args);
+ $result = $this->property->method($args);
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### CatchExceptionNameMatchingTypeRector
2019-05-26 13:47:23 +02:00
2020-11-25 22:34:34 +01:00
Type and name of catch exception should match
2019-05-26 13:47:23 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\Catch_\CatchExceptionNameMatchingTypeRector` ](../rules/CodingStyle/Rector/Catch_/CatchExceptionNameMatchingTypeRector.php )
2019-05-26 13:47:23 +02:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2019-05-26 13:47:23 +02:00
{
2020-11-25 22:34:34 +01:00
public function run()
2019-05-26 13:47:23 +02:00
{
2020-11-25 22:34:34 +01:00
try {
// ...
- } catch (SomeException $typoException) {
- $typoException->getMessage();
+ } catch (SomeException $someException) {
+ $someException->getMessage();
}
2019-05-26 13:47:23 +02:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-09-11 11:21:48 +02:00
2020-11-25 22:34:34 +01:00
### ConsistentImplodeRector
2020-09-24 20:54:39 +02:00
2021-04-10 20:18:49 +02:00
Changes various implode forms to consistent one
2020-09-11 11:21:48 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\FuncCall\ConsistentImplodeRector` ](../rules/CodingStyle/Rector/FuncCall/ConsistentImplodeRector.php )
2020-09-24 20:54:39 +02:00
2020-11-16 17:50:38 +00:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
{
public function run(array $items)
{
- $itemsAsStrings = implode($items);
- $itemsAsStrings = implode($items, '|');
+ $itemsAsStrings = implode('', $items);
+ $itemsAsStrings = implode('|', $items);
}
}
2019-02-04 01:32:53 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-11-11 13:22:35 +01:00
2021-01-30 21:30:37 +01:00
### CountArrayToEmptyArrayComparisonRector
2021-04-10 20:18:49 +02:00
Change count array comparison to empty array comparison to improve performance
2021-01-30 21:30:37 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\FuncCall\CountArrayToEmptyArrayComparisonRector` ](../rules/CodingStyle/Rector/FuncCall/CountArrayToEmptyArrayComparisonRector.php )
2021-01-30 21:30:37 +01:00
```diff
-count($array) === 0;
-count($array) > 0;
-! count($array);
+$array === [];
+$array !== [];
+$array === [];
```
< br >
2020-11-25 22:34:34 +01:00
### EncapsedStringsToSprintfRector
2019-10-15 16:46:31 +02:00
2023-03-26 00:33:56 +00:00
Convert enscaped {$string} to more readable sprintf or concat, if no mask is used
2019-10-15 16:46:31 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\Encapsed\EncapsedStringsToSprintfRector` ](../rules/CodingStyle/Rector/Encapsed/EncapsedStringsToSprintfRector.php )
2019-10-15 16:46:31 +02:00
2020-11-16 17:50:38 +00:00
```diff
2023-09-05 13:21:31 +00:00
-echo "Unsupported format {$format} - use another";
+echo sprintf('Unsupported format %s - use another', $format);
-echo "Try {$allowed}";
+echo 'Try ' . $allowed;
2020-11-16 17:50:38 +00:00
```
2020-09-11 11:21:48 +02:00
2020-11-16 17:50:38 +00:00
< br >
2020-09-24 20:54:39 +02:00
2021-05-09 02:15:50 +02:00
### FuncGetArgsToVariadicParamRector
Refactor `func_get_args()` in to a variadic param
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\ClassMethod\FuncGetArgsToVariadicParamRector` ](../rules/CodingStyle/Rector/ClassMethod/FuncGetArgsToVariadicParamRector.php )
2021-05-09 02:15:50 +02:00
```diff
-function run()
+function run(...$args)
{
- $args = \func_get_args();
}
```
< br >
2020-11-25 22:34:34 +01:00
### MakeInheritedMethodVisibilitySameAsParentRector
2020-11-16 17:50:38 +00:00
2020-11-25 22:34:34 +01:00
Make method visibility same as parent one
2020-11-16 17:50:38 +00:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\ClassMethod\MakeInheritedMethodVisibilitySameAsParentRector` ](../rules/CodingStyle/Rector/ClassMethod/MakeInheritedMethodVisibilitySameAsParentRector.php )
2020-11-16 17:50:38 +00:00
```diff
2020-11-25 22:34:34 +01:00
class ChildClass extends ParentClass
{
- public function run()
+ protected function run()
{
}
}
2020-11-16 17:50:38 +00:00
2020-11-25 22:34:34 +01:00
class ParentClass
2019-09-28 00:34:34 +02:00
{
2020-11-25 22:34:34 +01:00
protected function run()
{
}
2019-09-28 00:34:34 +02:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2019-09-28 00:34:34 +02:00
2021-09-05 00:37:33 +00:00
### NewlineAfterStatementRector
Add new line after statements to tidify code
- class: [`Rector\CodingStyle\Rector\Stmt\NewlineAfterStatementRector` ](../rules/CodingStyle/Rector/Stmt/NewlineAfterStatementRector.php )
```diff
class SomeClass
{
2022-07-03 21:09:19 +00:00
public function first()
2021-09-05 00:37:33 +00:00
{
}
+
2022-07-03 21:09:19 +00:00
public function second()
2021-09-05 00:37:33 +00:00
{
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### NewlineBeforeNewAssignSetRector
2019-08-05 23:10:47 +02:00
2020-11-25 22:34:34 +01:00
Add extra space before new assign set
2019-08-05 23:10:47 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\ClassMethod\NewlineBeforeNewAssignSetRector` ](../rules/CodingStyle/Rector/ClassMethod/NewlineBeforeNewAssignSetRector.php )
2019-08-05 23:10:47 +02:00
```diff
2020-11-25 22:34:34 +01:00
final class SomeClass
2019-08-05 23:10:47 +02:00
{
public function run()
{
2020-11-25 22:34:34 +01:00
$value = new Value;
$value->setValue(5);
+
$value2 = new Value;
$value2->setValue(1);
2019-08-05 23:10:47 +02:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2019-08-05 23:10:47 +02:00
2020-11-25 22:34:34 +01:00
### NullableCompareToNullRector
2019-01-03 11:54:13 +01:00
2020-11-25 22:34:34 +01:00
Changes negate of empty comparison of nullable value to explicit === or !== compare
2019-01-03 11:54:13 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\If_\NullableCompareToNullRector` ](../rules/CodingStyle/Rector/If_/NullableCompareToNullRector.php )
2019-01-03 11:54:13 +01:00
```diff
2020-11-25 22:34:34 +01:00
/** @var stdClass|null $value */
-if ($value) {
+if ($value !== null) {
}
2019-01-03 11:54:13 +01:00
2020-11-25 22:34:34 +01:00
-if (!$value) {
+if ($value === null) {
2019-01-03 11:54:13 +01:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-07-24 13:46:57 +02:00
2020-12-22 16:48:25 +01:00
### PostIncDecToPreIncDecRector
Use ++$value or --$value instead of `$value++` or `$value--`
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\PostInc\PostIncDecToPreIncDecRector` ](../rules/CodingStyle/Rector/PostInc/PostIncDecToPreIncDecRector.php )
2020-12-22 16:48:25 +01:00
```diff
class SomeClass
{
public function run($value = 1)
{
- $value++; echo $value;
- $value--; echo $value;
+ ++$value; echo $value;
+ --$value; echo $value;
}
}
```
< br >
2022-01-26 18:39:23 +00:00
### RemoveFinalFromConstRector
Remove final from constants in classes defined as final
- class: [`Rector\CodingStyle\Rector\ClassConst\RemoveFinalFromConstRector` ](../rules/CodingStyle/Rector/ClassConst/RemoveFinalFromConstRector.php )
```diff
final class SomeClass
{
- final public const NAME = 'value';
+ public const NAME = 'value';
}
```
< br >
2023-12-26 17:40:03 +00:00
### RemoveUselessAliasInUseStatementRector
Remove useless alias in use statement as same name with last use statement name
- class: [`Rector\CodingStyle\Rector\Stmt\RemoveUselessAliasInUseStatementRector` ](../rules/CodingStyle/Rector/Stmt/RemoveUselessAliasInUseStatementRector.php )
```diff
-use App\Bar as Bar;
+use App\Bar;
```
< br >
2021-05-09 02:15:50 +02:00
### SeparateMultiUseImportsRector
Split multi use imports and trait statements to standalone lines
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\Use_\SeparateMultiUseImportsRector` ](../rules/CodingStyle/Rector/Use_/SeparateMultiUseImportsRector.php )
2021-05-09 02:15:50 +02:00
```diff
-use A, B;
+use A;
+use B;
class SomeClass
{
- use SomeTrait, AnotherTrait;
+ use SomeTrait;
+ use AnotherTrait;
}
```
< br >
2020-11-25 22:34:34 +01:00
### SplitDoubleAssignRector
2020-09-24 20:54:39 +02:00
2021-03-15 18:58:04 +01:00
Split multiple inline assigns to each own lines default value, to prevent undefined array issues
2019-06-02 10:45:37 +03:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\Assign\SplitDoubleAssignRector` ](../rules/CodingStyle/Rector/Assign/SplitDoubleAssignRector.php )
2019-05-26 13:47:23 +02:00
```diff
2020-11-16 17:50:38 +00:00
class SomeClass
2019-05-26 13:47:23 +02:00
{
2020-11-16 17:50:38 +00:00
public function run()
2019-05-26 13:47:23 +02:00
{
2020-11-25 22:34:34 +01:00
- $one = $two = 1;
+ $one = 1;
+ $two = 1;
2019-05-26 13:47:23 +02:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2019-05-26 13:47:23 +02:00
2022-12-05 15:46:09 +00:00
### SplitGroupedClassConstantsRector
Separate class constant to own lines
- class: [`Rector\CodingStyle\Rector\ClassConst\SplitGroupedClassConstantsRector` ](../rules/CodingStyle/Rector/ClassConst/SplitGroupedClassConstantsRector.php )
```diff
class SomeClass
{
- const HI = true, HELLO = 'true';
+ const HI = true;
+ const HELLO = 'true';
}
```
< br >
### SplitGroupedPropertiesRector
Separate grouped properties to own lines
- class: [`Rector\CodingStyle\Rector\Property\SplitGroupedPropertiesRector` ](../rules/CodingStyle/Rector/Property/SplitGroupedPropertiesRector.php )
```diff
class SomeClass
{
/**
* @var string
*/
- public $isIt, $isIsThough;
+ public $isIt;
+
+ /**
+ * @var string
+ */
+ public $isIsThough;
}
```
< br >
2022-07-13 20:35:23 +00:00
### StaticArrowFunctionRector
Changes ArrowFunction to be static when possible
- class: [`Rector\CodingStyle\Rector\ArrowFunction\StaticArrowFunctionRector` ](../rules/CodingStyle/Rector/ArrowFunction/StaticArrowFunctionRector.php )
```diff
-fn (): string => 'test';
+static fn (): string => 'test';
```
< br >
### StaticClosureRector
Changes Closure to be static when possible
- class: [`Rector\CodingStyle\Rector\Closure\StaticClosureRector` ](../rules/CodingStyle/Rector/Closure/StaticClosureRector.php )
```diff
-function () {
+static function () {
if (rand(0, 1)) {
return 1;
}
return 2;
}
```
< br >
2020-11-25 22:34:34 +01:00
### StrictArraySearchRector
2019-05-26 13:47:23 +02:00
2021-04-10 20:18:49 +02:00
Makes array_search search for identical elements
2019-05-26 13:47:23 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\FuncCall\StrictArraySearchRector` ](../rules/CodingStyle/Rector/FuncCall/StrictArraySearchRector.php )
2019-05-26 13:47:23 +02:00
```diff
2020-11-25 22:34:34 +01:00
-array_search($value, $items);
+array_search($value, $items, true);
2019-05-26 13:47:23 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-05-26 13:47:23 +02:00
2020-11-25 22:34:34 +01:00
### SymplifyQuoteEscapeRector
2019-09-28 00:34:34 +02:00
2020-11-25 22:34:34 +01:00
Prefer quote that are not inside the string
2019-09-28 00:34:34 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\String_\SymplifyQuoteEscapeRector` ](../rules/CodingStyle/Rector/String_/SymplifyQuoteEscapeRector.php )
2019-09-28 00:34:34 +02:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2019-06-02 10:45:37 +03:00
{
2020-11-25 22:34:34 +01:00
public function run()
2019-06-02 10:45:37 +03:00
{
2020-11-25 22:34:34 +01:00
- $name = "\" Tom";
- $name = '\' Sara';
+ $name = '" Tom';
+ $name = "' Sara";
2019-06-02 10:45:37 +03:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2019-06-02 10:45:37 +03:00
2020-11-25 22:34:34 +01:00
### TernaryConditionVariableAssignmentRector
2020-07-16 16:40:04 +01:00
2020-11-25 22:34:34 +01:00
Assign outcome of ternary condition to variable, where applicable
2020-07-16 16:40:04 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\Ternary\TernaryConditionVariableAssignmentRector` ](../rules/CodingStyle/Rector/Ternary/TernaryConditionVariableAssignmentRector.php )
2020-07-16 16:40:04 +01:00
```diff
2020-11-25 22:34:34 +01:00
function ternary($value)
2020-07-13 23:13:40 +02:00
{
2020-11-25 22:34:34 +01:00
- $value ? $a = 1 : $a = 0;
+ $a = $value ? 1 : 0;
2020-07-13 23:13:40 +02:00
}
2020-07-16 16:40:04 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-07-16 16:40:04 +01:00
2020-11-25 22:34:34 +01:00
### UseClassKeywordForClassNameResolutionRector
2020-06-29 20:36:58 +02:00
2020-11-25 22:34:34 +01:00
Use `class` keyword for class name resolution in string instead of hardcoded string reference
2020-06-29 20:36:58 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\String_\UseClassKeywordForClassNameResolutionRector` ](../rules/CodingStyle/Rector/String_/UseClassKeywordForClassNameResolutionRector.php )
2020-06-29 20:36:58 +02:00
```diff
2020-11-25 22:34:34 +01:00
-$value = 'App\SomeClass::someMethod()';
2021-11-25 12:53:25 +00:00
+$value = \App\SomeClass::class . '::someMethod()';
2019-10-04 16:59:42 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-10-04 16:59:42 +02:00
2020-11-25 22:34:34 +01:00
### UseIncrementAssignRector
2020-08-30 20:48:37 +02:00
2020-11-25 22:34:34 +01:00
Use ++ increment instead of `$var += 1`
2020-08-30 20:48:37 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\Plus\UseIncrementAssignRector` ](../rules/CodingStyle/Rector/Plus/UseIncrementAssignRector.php )
2020-08-30 20:48:37 +02:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2020-08-30 20:48:37 +02:00
{
2020-11-25 22:34:34 +01:00
public function run()
2020-08-30 20:48:37 +02:00
{
2020-11-25 22:34:34 +01:00
- $style += 1;
2020-12-22 16:48:25 +01:00
+ ++$style;
2020-08-30 20:48:37 +02:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-08-30 20:48:37 +02:00
2020-11-25 22:34:34 +01:00
### VersionCompareFuncCallToConstantRector
2020-07-21 18:13:15 +01:00
2020-11-25 22:34:34 +01:00
Changes use of call to version compare function to use of PHP version constant
2020-07-21 18:13:15 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\FuncCall\VersionCompareFuncCallToConstantRector` ](../rules/CodingStyle/Rector/FuncCall/VersionCompareFuncCallToConstantRector.php )
2020-07-21 18:13:15 +01:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2020-07-21 18:13:15 +01:00
{
2020-11-25 22:34:34 +01:00
public function run()
2020-11-16 17:50:38 +00:00
{
2020-11-25 22:34:34 +01:00
- version_compare(PHP_VERSION, '5.3.0', '< ');
+ PHP_VERSION_ID < 50300 ;
2020-11-16 17:50:38 +00:00
}
2020-07-21 18:13:15 +01:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-07-21 18:13:15 +01:00
2020-11-25 22:34:34 +01:00
### WrapEncapsedVariableInCurlyBracesRector
2020-09-24 20:54:39 +02:00
2020-11-25 22:34:34 +01:00
Wrap encapsed variables in curly braces
2019-05-29 15:40:20 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\CodingStyle\Rector\Encapsed\WrapEncapsedVariableInCurlyBracesRector` ](../rules/CodingStyle/Rector/Encapsed/WrapEncapsedVariableInCurlyBracesRector.php )
2019-01-03 11:54:13 +01:00
```diff
2020-11-25 22:34:34 +01:00
function run($world)
2020-11-16 17:50:38 +00:00
{
2021-07-22 18:40:24 +00:00
- echo "Hello $world!";
+ echo "Hello {$world}!";
2020-11-16 17:50:38 +00:00
}
```
2019-02-04 01:32:53 +01:00
2020-11-16 17:50:38 +00:00
< br >
2019-09-06 12:30:58 +02:00
2020-11-25 22:34:34 +01:00
## DeadCode
2020-03-25 22:51:12 +01:00
2021-01-01 19:59:23 +01:00
### RecastingRemovalRector
Removes recasting of the same type
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\Cast\RecastingRemovalRector` ](../rules/DeadCode/Rector/Cast/RecastingRemovalRector.php )
2021-01-01 19:59:23 +01:00
```diff
$string = '';
-$string = (string) $string;
+$string = $string;
$array = [];
-$array = (array) $array;
+$array = $array;
```
< br >
2020-11-25 22:34:34 +01:00
### RemoveAlwaysTrueIfConditionRector
2020-03-25 22:51:12 +01:00
2020-11-25 22:34:34 +01:00
Remove if condition that is always true
2020-03-25 22:51:12 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\If_\RemoveAlwaysTrueIfConditionRector` ](../rules/DeadCode/Rector/If_/RemoveAlwaysTrueIfConditionRector.php )
2020-11-16 17:50:38 +00:00
2020-11-25 22:34:34 +01:00
```diff
final class SomeClass
2020-03-25 22:51:12 +01:00
{
2020-11-25 22:34:34 +01:00
public function go()
2020-03-25 22:51:12 +01:00
{
2020-11-25 22:34:34 +01:00
- if (1 === 1) {
- return 'yes';
- }
+ return 'yes';
2020-03-25 22:51:12 +01:00
2020-11-25 22:34:34 +01:00
return 'no';
2020-03-25 22:51:12 +01:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-03-25 22:51:12 +01:00
2020-11-25 22:34:34 +01:00
### RemoveAndTrueRector
2019-02-04 01:32:53 +01:00
2020-11-25 22:34:34 +01:00
Remove and true that has no added value
2019-02-04 01:32:53 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\BooleanAnd\RemoveAndTrueRector` ](../rules/DeadCode/Rector/BooleanAnd/RemoveAndTrueRector.php )
2019-02-04 01:32:53 +01:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2019-06-02 10:45:37 +03:00
{
2020-11-25 22:34:34 +01:00
public function run()
2019-06-02 10:45:37 +03:00
{
2020-11-25 22:34:34 +01:00
- return true && 5 === 1;
+ return 5 === 1;
2019-06-02 10:45:37 +03:00
}
}
2019-02-04 01:32:53 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-02-04 01:32:53 +01:00
2021-03-23 23:13:35 +01:00
### RemoveAnnotationRector
Remove annotation by names
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\ClassLike\RemoveAnnotationRector` ](../rules/DeadCode/Rector/ClassLike/RemoveAnnotationRector.php )
2021-03-23 23:13:35 +01:00
```diff
-/**
- * @method getName()
- */
final class SomeClass
{
}
```
< br >
2020-11-25 22:34:34 +01:00
### RemoveConcatAutocastRector
2020-03-30 21:08:12 +02:00
2020-11-25 22:34:34 +01:00
Remove (string) casting when it comes to concat, that does this by default
2020-03-30 21:08:12 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\Concat\RemoveConcatAutocastRector` ](../rules/DeadCode/Rector/Concat/RemoveConcatAutocastRector.php )
2020-03-30 21:08:12 +02:00
```diff
2020-11-25 22:34:34 +01:00
class SomeConcatingClass
2020-03-30 21:08:12 +02:00
{
2020-11-25 22:34:34 +01:00
public function run($value)
2020-11-16 17:50:38 +00:00
{
2020-11-25 22:34:34 +01:00
- return 'hi ' . (string) $value;
+ return 'hi ' . $value;
2020-11-16 17:50:38 +00:00
}
2020-03-30 21:08:12 +02:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-03-30 21:08:12 +02:00
2021-01-16 13:23:37 +01:00
### RemoveDeadConditionAboveReturnRector
Remove dead condition above return
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\Return_\RemoveDeadConditionAboveReturnRector` ](../rules/DeadCode/Rector/Return_/RemoveDeadConditionAboveReturnRector.php )
2021-01-16 13:23:37 +01:00
```diff
final class SomeClass
{
public function go()
{
- if (1 === 1) {
- return 'yes';
- }
-
return 'yes';
}
}
```
< br >
2021-11-28 17:29:16 +00:00
### RemoveDeadContinueRector
Remove useless continue at the end of loops
- class: [`Rector\DeadCode\Rector\For_\RemoveDeadContinueRector` ](../rules/DeadCode/Rector/For_/RemoveDeadContinueRector.php )
```diff
while ($i < 10 ) {
++$i;
- continue;
}
```
< br >
2020-11-25 22:34:34 +01:00
### RemoveDeadIfForeachForRector
2018-12-31 12:50:32 +01:00
2020-11-25 22:34:34 +01:00
Remove if, foreach and for that does not do anything
2018-12-31 12:50:32 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\For_\RemoveDeadIfForeachForRector` ](../rules/DeadCode/Rector/For_/RemoveDeadIfForeachForRector.php )
2018-12-31 12:50:32 +01:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2020-02-14 11:25:21 +01:00
{
2023-06-05 13:46:42 +00:00
public function run($value)
2020-02-14 11:25:21 +01:00
{
2020-11-25 22:34:34 +01:00
- if ($value) {
- }
-
2023-06-05 13:46:42 +00:00
- foreach ($values as $value) {
2020-11-25 22:34:34 +01:00
- }
-
return $value;
2020-02-14 11:25:21 +01:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-02-14 11:25:21 +01:00
2021-02-13 15:57:30 +01:00
### RemoveDeadInstanceOfRector
Remove dead instanceof check on type hinted variable
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\If_\RemoveDeadInstanceOfRector` ](../rules/DeadCode/Rector/If_/RemoveDeadInstanceOfRector.php )
2021-02-13 15:57:30 +01:00
```diff
2023-06-11 00:36:16 +00:00
function run(stdClass $stdClass)
2021-02-13 15:57:30 +01:00
{
2023-06-11 00:36:16 +00:00
- if (! $stdClass instanceof stdClass) {
- return false;
- }
2021-02-13 15:57:30 +01:00
-
2023-06-11 00:36:16 +00:00
return true;
2021-02-13 15:57:30 +01:00
}
```
< br >
2021-02-21 00:02:05 +01:00
### RemoveDeadLoopRector
Remove loop with no body
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\For_\RemoveDeadLoopRector` ](../rules/DeadCode/Rector/For_/RemoveDeadLoopRector.php )
2021-02-21 00:02:05 +01:00
```diff
class SomeClass
{
public function run($values)
{
- for ($i=1; $i< count ($ values ); ++$ i ) {
- }
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### RemoveDeadReturnRector
2019-03-09 13:24:30 +00:00
2020-11-25 22:34:34 +01:00
Remove last return in the functions, since does not do anything
2019-03-09 13:24:30 +00:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\FunctionLike\RemoveDeadReturnRector` ](../rules/DeadCode/Rector/FunctionLike/RemoveDeadReturnRector.php )
2019-03-09 13:24:30 +00:00
```diff
class SomeClass
{
2020-11-16 17:50:38 +00:00
public function run()
2019-02-21 15:36:16 +01:00
{
2020-11-25 22:34:34 +01:00
$shallWeDoThis = true;
if ($shallWeDoThis) {
return;
}
-
- return;
2019-02-21 15:36:16 +01:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2019-02-21 15:36:16 +01:00
2020-11-25 22:34:34 +01:00
### RemoveDeadStmtRector
2019-07-06 21:51:36 +02:00
2020-11-25 22:34:34 +01:00
Removes dead code statements
2019-07-06 21:51:36 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\Expression\RemoveDeadStmtRector` ](../rules/DeadCode/Rector/Expression/RemoveDeadStmtRector.php )
2020-06-16 13:39:38 +02:00
2019-07-06 21:51:36 +02:00
```diff
2020-11-25 22:34:34 +01:00
-$value = 5;
-$value;
+$value = 5;
2019-07-06 21:51:36 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-07-06 21:51:36 +02:00
2020-11-25 22:34:34 +01:00
### RemoveDeadTryCatchRector
2019-02-18 16:51:24 +01:00
2020-11-25 22:34:34 +01:00
Remove dead try/catch
2019-02-18 16:51:24 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\TryCatch\RemoveDeadTryCatchRector` ](../rules/DeadCode/Rector/TryCatch/RemoveDeadTryCatchRector.php )
2019-02-18 16:51:24 +01:00
```diff
2020-11-16 17:50:38 +00:00
class SomeClass
{
2020-11-25 22:34:34 +01:00
public function run()
2020-11-16 17:50:38 +00:00
{
2020-11-25 22:34:34 +01:00
- try {
- // some code
- }
- catch (Throwable $throwable) {
- throw $throwable;
- }
2020-11-16 17:50:38 +00:00
}
}
2019-05-19 10:27:38 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-05-19 10:27:38 +02:00
2020-11-25 22:34:34 +01:00
### RemoveDeadZeroAndOneOperationRector
2019-08-05 23:10:47 +02:00
2020-11-25 22:34:34 +01:00
Remove operation with 1 and 0, that have no effect on the value
2019-08-05 23:10:47 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\Plus\RemoveDeadZeroAndOneOperationRector` ](../rules/DeadCode/Rector/Plus/RemoveDeadZeroAndOneOperationRector.php )
2019-08-05 23:10:47 +02:00
```diff
class SomeClass
{
public function run()
{
2020-11-25 22:34:34 +01:00
- $value = 5 * 1;
- $value = 5 + 0;
+ $value = 5;
+ $value = 5;
2019-08-05 23:10:47 +02:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2019-08-05 23:10:47 +02:00
2020-11-25 22:34:34 +01:00
### RemoveDoubleAssignRector
2019-03-31 14:25:39 +02:00
2020-11-25 22:34:34 +01:00
Simplify useless double assigns
2019-03-31 14:25:39 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\Assign\RemoveDoubleAssignRector` ](../rules/DeadCode/Rector/Assign/RemoveDoubleAssignRector.php )
2019-03-31 14:25:39 +02:00
```diff
2020-11-25 22:34:34 +01:00
-$value = 1;
$value = 1;
```
2020-11-16 17:50:38 +00:00
2020-11-25 22:34:34 +01:00
< br >
### RemoveDuplicatedArrayKeyRector
2021-04-10 20:18:49 +02:00
Remove duplicated key in defined arrays.
2020-11-25 22:34:34 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\Array_\RemoveDuplicatedArrayKeyRector` ](../rules/DeadCode/Rector/Array_/RemoveDuplicatedArrayKeyRector.php )
2020-11-25 22:34:34 +01:00
```diff
$item = [
- 1 => 'A',
1 => 'B'
];
2019-03-31 14:25:39 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-03-31 14:25:39 +02:00
2020-11-25 22:34:34 +01:00
### RemoveDuplicatedCaseInSwitchRector
2020-10-18 18:29:35 +02:00
2020-11-25 22:34:34 +01:00
2 following switch keys with identical will be reduced to one result
2020-10-18 18:29:35 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\Switch_\RemoveDuplicatedCaseInSwitchRector` ](../rules/DeadCode/Rector/Switch_/RemoveDuplicatedCaseInSwitchRector.php )
2020-10-18 18:29:35 +02:00
```diff
class SomeClass
{
2020-11-16 17:50:38 +00:00
public function run()
2020-10-18 18:29:35 +02:00
{
2020-11-25 22:34:34 +01:00
switch ($name) {
case 'clearHeader':
return $this->modifyHeader($node, 'remove');
case 'clearAllHeaders':
- return $this->modifyHeader($node, 'replace');
case 'clearRawHeaders':
return $this->modifyHeader($node, 'replace');
case '...':
return 5;
2020-11-16 17:50:38 +00:00
}
2020-10-18 18:29:35 +02:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-10-18 18:29:35 +02:00
2020-11-25 22:34:34 +01:00
### RemoveEmptyClassMethodRector
2018-12-25 20:55:16 +01:00
2021-04-10 20:18:49 +02:00
Remove empty class methods not required by parents
2018-12-25 20:55:16 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\ClassMethod\RemoveEmptyClassMethodRector` ](../rules/DeadCode/Rector/ClassMethod/RemoveEmptyClassMethodRector.php )
2018-12-25 20:55:16 +01:00
```diff
2020-11-25 22:34:34 +01:00
class OrphanClass
2019-05-29 15:40:20 +02:00
{
2020-11-25 22:34:34 +01:00
- public function __construct()
- {
- }
2019-05-29 15:40:20 +02:00
}
2018-12-25 20:55:16 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-12-25 20:55:16 +01:00
2021-03-23 23:13:35 +01:00
### RemoveNonExistingVarAnnotationRector
Removes non-existing `@var` annotations above the code
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\Node\RemoveNonExistingVarAnnotationRector` ](../rules/DeadCode/Rector/Node/RemoveNonExistingVarAnnotationRector.php )
2021-03-23 23:13:35 +01:00
```diff
class SomeClass
{
public function get()
{
- /** @var Training[] $trainings */
return $this->getData();
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### RemoveNullPropertyInitializationRector
2020-11-16 17:50:38 +00:00
2020-11-25 22:34:34 +01:00
Remove initialization with null value from property declarations
2019-08-17 15:06:02 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\PropertyProperty\RemoveNullPropertyInitializationRector` ](../rules/DeadCode/Rector/PropertyProperty/RemoveNullPropertyInitializationRector.php )
2019-08-17 15:06:02 +02:00
2020-11-25 22:34:34 +01:00
```diff
class SunshineCommand extends ParentClassWithNewConstructor
2019-08-17 15:06:02 +02:00
{
2020-11-25 22:34:34 +01:00
- private $myVar = null;
+ private $myVar;
2019-08-17 15:06:02 +02:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2019-08-17 15:06:02 +02:00
2023-12-10 16:32:52 +00:00
### RemoveNullTagValueNodeRector
Remove `@var/@param/@return` null docblock
- class: [`Rector\DeadCode\Rector\ClassMethod\RemoveNullTagValueNodeRector` ](../rules/DeadCode/Rector/ClassMethod/RemoveNullTagValueNodeRector.php )
```diff
class SomeClass
{
- /**
- * @return null
- */
public function foo()
{
return null;
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### RemoveParentCallWithoutParentRector
2020-04-13 23:44:44 +02:00
2020-11-25 22:34:34 +01:00
Remove unused parent call with no parent class
2020-04-13 23:44:44 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\StaticCall\RemoveParentCallWithoutParentRector` ](../rules/DeadCode/Rector/StaticCall/RemoveParentCallWithoutParentRector.php )
2020-04-13 23:44:44 +02:00
```diff
2020-11-25 22:34:34 +01:00
class OrphanClass
2020-11-16 17:50:38 +00:00
{
2020-11-25 22:34:34 +01:00
public function __construct()
2020-04-13 23:44:44 +02:00
{
2020-11-25 22:34:34 +01:00
- parent::__construct();
2020-04-13 23:44:44 +02:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-04-13 23:44:44 +02:00
2021-06-27 14:06:45 +00:00
### RemovePhpVersionIdCheckRector
2022-05-08 00:33:36 +00:00
Remove unneeded PHP_VERSION_ID conditional checks
2021-06-27 14:06:45 +00:00
- class: [`Rector\DeadCode\Rector\ConstFetch\RemovePhpVersionIdCheckRector` ](../rules/DeadCode/Rector/ConstFetch/RemovePhpVersionIdCheckRector.php )
```diff
class SomeClass
{
public function run()
{
- if (PHP_VERSION_ID < 80000 ) {
- return;
- }
2022-05-08 00:33:36 +00:00
-
2021-06-27 14:06:45 +00:00
echo 'do something';
}
}
```
< br >
2023-06-11 00:36:16 +00:00
### RemoveTypedPropertyDeadInstanceOfRector
Remove dead instanceof check on type hinted property
- class: [`Rector\DeadCode\Rector\If_\RemoveTypedPropertyDeadInstanceOfRector` ](../rules/DeadCode/Rector/If_/RemoveTypedPropertyDeadInstanceOfRector.php )
```diff
final class SomeClass
{
private $someObject;
2023-06-11 00:39:52 +00:00
public function __construct(SomeObject $someObject)
2023-06-11 00:36:16 +00:00
{
$this->someObject = $someObject;
}
public function run()
{
- if ($this->someObject instanceof SomeObject) {
- return true;
- }
-
- return false;
+ return true;
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### RemoveUnreachableStatementRector
2020-01-05 00:18:57 +01:00
2020-11-25 22:34:34 +01:00
Remove unreachable statements
2020-01-05 00:18:57 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\Stmt\RemoveUnreachableStatementRector` ](../rules/DeadCode/Rector/Stmt/RemoveUnreachableStatementRector.php )
2020-01-05 00:18:57 +01:00
```diff
2020-11-16 17:50:38 +00:00
class SomeClass
2020-01-05 00:18:57 +01:00
{
2020-11-16 17:50:38 +00:00
public function run()
2020-01-05 00:18:57 +01:00
{
2020-11-25 22:34:34 +01:00
return 5;
2020-01-05 00:18:57 +01:00
-
2020-11-25 22:34:34 +01:00
- $removeMe = 10;
2020-11-16 17:50:38 +00:00
}
2020-01-05 00:18:57 +01:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-01-05 00:18:57 +01:00
2021-02-13 15:57:30 +01:00
### RemoveUnusedConstructorParamRector
Remove unused parameter in constructor
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\ClassMethod\RemoveUnusedConstructorParamRector` ](../rules/DeadCode/Rector/ClassMethod/RemoveUnusedConstructorParamRector.php )
2021-02-13 15:57:30 +01:00
```diff
final class SomeClass
{
private $hey;
- public function __construct($hey, $man)
+ public function __construct($hey)
{
$this->hey = $hey;
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### RemoveUnusedForeachKeyRector
2020-03-25 19:00:26 +01:00
2021-04-10 20:18:49 +02:00
Remove unused key in foreach
2020-11-16 17:50:38 +00:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\Foreach_\RemoveUnusedForeachKeyRector` ](../rules/DeadCode/Rector/Foreach_/RemoveUnusedForeachKeyRector.php )
2020-11-16 17:50:38 +00:00
2020-11-25 22:34:34 +01:00
```diff
$items = [];
-foreach ($items as $key => $value) {
+foreach ($items as $value) {
$result = $value;
2020-03-25 19:00:26 +01:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-03-25 19:00:26 +01:00
2020-11-25 22:34:34 +01:00
### RemoveUnusedNonEmptyArrayBeforeForeachRector
2019-02-21 15:36:16 +01:00
2020-11-25 22:34:34 +01:00
Remove unused if check to non-empty array before foreach of the array
2019-02-21 15:36:16 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\If_\RemoveUnusedNonEmptyArrayBeforeForeachRector` ](../rules/DeadCode/Rector/If_/RemoveUnusedNonEmptyArrayBeforeForeachRector.php )
2019-02-21 15:36:16 +01:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2019-02-21 15:36:16 +01:00
{
2020-11-25 22:34:34 +01:00
public function run()
2019-02-21 15:36:16 +01:00
{
2020-11-25 22:34:34 +01:00
$values = [];
- if ($values !== []) {
- foreach ($values as $value) {
- echo $value;
- }
+ foreach ($values as $value) {
+ echo $value;
}
2019-02-21 15:36:16 +01:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2019-02-21 15:36:16 +01:00
2021-03-23 23:13:35 +01:00
### RemoveUnusedPrivateClassConstantRector
2019-03-31 14:25:39 +02:00
2021-03-23 23:13:35 +01:00
Remove unused class constants
2019-03-31 14:25:39 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\ClassConst\RemoveUnusedPrivateClassConstantRector` ](../rules/DeadCode/Rector/ClassConst/RemoveUnusedPrivateClassConstantRector.php )
2019-03-31 14:25:39 +02:00
```diff
2020-11-16 17:50:38 +00:00
class SomeClass
2019-03-31 14:25:39 +02:00
{
2021-03-23 23:13:35 +01:00
- private const SOME_CONST = 'dead';
-
public function run()
2019-06-02 10:45:37 +03:00
{
2020-11-16 17:50:38 +00:00
}
2019-03-31 14:25:39 +02:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2019-03-31 14:25:39 +02:00
2021-04-25 11:44:34 +02:00
### RemoveUnusedPrivateMethodParameterRector
Remove unused parameter, if not required by interface or parent class
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodParameterRector` ](../rules/DeadCode/Rector/ClassMethod/RemoveUnusedPrivateMethodParameterRector.php )
2021-04-25 11:44:34 +02:00
```diff
class SomeClass
{
- private function run($value, $value2)
+ private function run($value)
{
$this->value = $value;
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### RemoveUnusedPrivateMethodRector
2020-02-23 22:14:24 +01:00
2020-11-25 22:34:34 +01:00
Remove unused private method
2020-02-23 22:14:24 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector` ](../rules/DeadCode/Rector/ClassMethod/RemoveUnusedPrivateMethodRector.php )
2020-02-23 22:14:24 +01:00
```diff
2020-11-25 22:34:34 +01:00
final class SomeController
2020-02-23 22:14:24 +01:00
{
public function run()
{
2020-11-25 22:34:34 +01:00
return 5;
2020-02-23 22:14:24 +01:00
}
2020-11-25 22:34:34 +01:00
-
- private function skip()
- {
- return 10;
- }
2020-02-23 22:14:24 +01:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-02-23 22:14:24 +01:00
2020-11-25 22:34:34 +01:00
### RemoveUnusedPrivatePropertyRector
2019-10-15 16:46:31 +02:00
2020-11-25 22:34:34 +01:00
Remove unused private properties
2019-10-15 16:46:31 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\Property\RemoveUnusedPrivatePropertyRector` ](../rules/DeadCode/Rector/Property/RemoveUnusedPrivatePropertyRector.php )
2019-10-15 16:46:31 +02:00
```diff
class SomeClass
{
2020-11-25 22:34:34 +01:00
- private $property;
2019-10-15 16:46:31 +02:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2019-10-15 16:46:31 +02:00
2021-06-27 14:06:45 +00:00
### RemoveUnusedPromotedPropertyRector
Remove unused promoted property
- class: [`Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPromotedPropertyRector` ](../rules/DeadCode/Rector/ClassMethod/RemoveUnusedPromotedPropertyRector.php )
```diff
class SomeClass
{
public function __construct(
- private $someUnusedDependency,
private $usedDependency
) {
}
public function getUsedDependency()
{
return $this->usedDependency;
}
}
```
< br >
2021-03-23 23:13:35 +01:00
### RemoveUnusedVariableAssignRector
2021-01-13 02:25:45 +01:00
2021-03-23 23:13:35 +01:00
Remove unused assigns to variables
2021-01-13 02:25:45 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\Assign\RemoveUnusedVariableAssignRector` ](../rules/DeadCode/Rector/Assign/RemoveUnusedVariableAssignRector.php )
2021-01-13 02:25:45 +01:00
```diff
class SomeClass
{
2021-03-23 23:13:35 +01:00
public function run()
2021-01-13 02:25:45 +01:00
{
2021-03-23 23:13:35 +01:00
- $value = 5;
2021-01-13 02:25:45 +01:00
}
2021-03-23 23:13:35 +01:00
}
```
2021-01-13 02:25:45 +01:00
2021-03-23 23:13:35 +01:00
< br >
### RemoveUselessParamTagRector
Remove `@param` docblock with same type as parameter type
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\ClassMethod\RemoveUselessParamTagRector` ](../rules/DeadCode/Rector/ClassMethod/RemoveUselessParamTagRector.php )
2021-03-23 23:13:35 +01:00
```diff
class SomeClass
{
/**
- * @param string $a
* @param string $b description
*/
public function foo(string $a, string $b)
2021-01-13 02:25:45 +01:00
{
}
}
```
< br >
2023-10-12 10:26:14 +00:00
### RemoveUselessReturnExprInConstructRector
Remove useless return Expr in `__construct()`
- class: [`Rector\DeadCode\Rector\ClassMethod\RemoveUselessReturnExprInConstructRector` ](../rules/DeadCode/Rector/ClassMethod/RemoveUselessReturnExprInConstructRector.php )
```diff
class SomeClass
{
public function __construct()
{
if (rand(0, 1)) {
$this->init();
- return true;
+ return;
}
if (rand(2, 3)) {
- return parent::construct();
+ parent::construct();
+ return;
}
$this->execute();
}
}
```
< br >
2021-03-23 23:13:35 +01:00
### RemoveUselessReturnTagRector
2019-06-02 10:45:37 +03:00
2021-03-23 23:13:35 +01:00
Remove `@return` docblock with same type as defined in PHP
2019-06-02 10:45:37 +03:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\ClassMethod\RemoveUselessReturnTagRector` ](../rules/DeadCode/Rector/ClassMethod/RemoveUselessReturnTagRector.php )
2019-06-02 10:45:37 +03:00
```diff
2021-03-23 23:13:35 +01:00
use stdClass;
2020-11-16 17:50:38 +00:00
class SomeClass
{
2021-03-23 23:13:35 +01:00
- /**
- * @return stdClass
- */
public function foo(): stdClass
2020-11-16 17:50:38 +00:00
{
}
}
```
2019-06-02 10:45:37 +03:00
2020-11-16 17:50:38 +00:00
< br >
2019-12-27 18:50:00 +01:00
2021-03-23 23:13:35 +01:00
### RemoveUselessVarTagRector
Remove unused `@var` annotation for properties
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\Property\RemoveUselessVarTagRector` ](../rules/DeadCode/Rector/Property/RemoveUselessVarTagRector.php )
2021-03-23 23:13:35 +01:00
```diff
final class SomeClass
{
- /**
- * @var string
- */
public string $name = 'name';
}
```
< br >
2020-11-25 22:34:34 +01:00
### SimplifyIfElseWithSameContentRector
2019-12-27 18:50:00 +01:00
2020-11-25 22:34:34 +01:00
Remove if/else if they have same content
2020-11-16 17:50:38 +00:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\If_\SimplifyIfElseWithSameContentRector` ](../rules/DeadCode/Rector/If_/SimplifyIfElseWithSameContentRector.php )
2019-12-27 18:50:00 +01:00
```diff
class SomeClass
{
2020-11-25 22:34:34 +01:00
public function run()
{
- if (true) {
- return 1;
- } else {
- return 1;
- }
+ return 1;
}
2019-12-27 18:50:00 +01:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-10-14 06:24:29 +02:00
2020-11-25 22:34:34 +01:00
### SimplifyMirrorAssignRector
2020-10-14 06:24:29 +02:00
2022-08-24 08:53:31 +00:00
Removes unneeded `$value` = `$value` assigns
2020-10-14 06:24:29 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\Expression\SimplifyMirrorAssignRector` ](../rules/DeadCode/Rector/Expression/SimplifyMirrorAssignRector.php )
2020-10-14 06:24:29 +02:00
```diff
2021-08-26 04:53:55 +00:00
function run() {
2022-08-24 08:53:31 +00:00
- $result = $result;
}
2020-10-14 06:24:29 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-10-14 06:24:29 +02:00
2020-11-25 22:34:34 +01:00
### TernaryToBooleanOrFalseToBooleanAndRector
2020-10-14 06:24:29 +02:00
2020-11-25 22:34:34 +01:00
Change ternary of bool : false to & & bool
2020-10-14 06:24:29 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\Ternary\TernaryToBooleanOrFalseToBooleanAndRector` ](../rules/DeadCode/Rector/Ternary/TernaryToBooleanOrFalseToBooleanAndRector.php )
2020-10-14 06:24:29 +02:00
```diff
2020-11-16 17:50:38 +00:00
class SomeClass
2020-10-14 06:24:29 +02:00
{
2020-11-25 22:34:34 +01:00
public function go()
2020-10-14 06:24:29 +02:00
{
2020-11-25 22:34:34 +01:00
- return $value ? $this->getBool() : false;
+ return $value & & $this->getBool();
}
private function getBool(): bool
{
return (bool) 5;
2020-10-14 06:24:29 +02:00
}
2020-11-16 17:50:38 +00:00
}
2020-10-14 06:24:29 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-10-14 06:24:29 +02:00
2021-01-30 21:30:37 +01:00
### UnwrapFutureCompatibleIfPhpVersionRector
Remove php version checks if they are passed
2021-05-23 09:33:26 +00:00
- class: [`Rector\DeadCode\Rector\If_\UnwrapFutureCompatibleIfPhpVersionRector` ](../rules/DeadCode/Rector/If_/UnwrapFutureCompatibleIfPhpVersionRector.php )
2021-01-30 21:30:37 +01:00
```diff
// current PHP: 7.2
-if (version_compare(PHP_VERSION, '7.2', '< ')) {
- return 'is PHP 7.1-';
-} else {
- return 'is PHP 7.2+';
-}
+return 'is PHP 7.2+';
```
< br >
2021-03-23 23:13:35 +01:00
## EarlyReturn
2020-09-08 12:00:38 +02:00
2021-03-23 23:13:35 +01:00
### ChangeAndIfToEarlyReturnRector
2020-11-16 17:50:38 +00:00
2021-03-23 23:13:35 +01:00
Changes if & & to early return
2021-05-23 09:33:26 +00:00
- class: [`Rector\EarlyReturn\Rector\If_\ChangeAndIfToEarlyReturnRector` ](../rules/EarlyReturn/Rector/If_/ChangeAndIfToEarlyReturnRector.php )
2020-11-16 17:50:38 +00:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2020-09-08 12:00:38 +02:00
{
2021-03-23 23:13:35 +01:00
public function canDrive(Car $car)
2020-09-08 12:00:38 +02:00
{
2021-03-23 23:13:35 +01:00
- if ($car->hasWheels && $car->hasFuel) {
- return true;
2022-08-24 08:11:57 +00:00
+ if (! $car->hasWheels) {
2021-03-23 23:13:35 +01:00
+ return false;
}
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
- return false;
2022-08-24 08:11:57 +00:00
+ if (! $car->hasFuel) {
2021-03-23 23:13:35 +01:00
+ return false;
+ }
+
+ return true;
2020-09-08 12:00:38 +02:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-09-08 12:00:38 +02:00
2021-03-23 23:13:35 +01:00
### ChangeIfElseValueAssignToEarlyReturnRector
2020-12-05 23:33:27 +01:00
2021-03-23 23:13:35 +01:00
Change if/else value to early return
2020-12-05 23:33:27 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\EarlyReturn\Rector\If_\ChangeIfElseValueAssignToEarlyReturnRector` ](../rules/EarlyReturn/Rector/If_/ChangeIfElseValueAssignToEarlyReturnRector.php )
2020-12-05 23:33:27 +01:00
```diff
class SomeClass
{
2021-03-23 23:13:35 +01:00
public function run()
2020-12-05 23:33:27 +01:00
{
2021-03-23 23:13:35 +01:00
if ($this->hasDocBlock($tokens, $index)) {
- $docToken = $tokens[$this->getDocBlockIndex($tokens, $index)];
- } else {
- $docToken = null;
+ return $tokens[$this->getDocBlockIndex($tokens, $index)];
}
-
- return $docToken;
+ return null;
2020-12-05 23:33:27 +01:00
}
}
```
< br >
2021-03-23 23:13:35 +01:00
### ChangeNestedForeachIfsToEarlyContinueRector
2020-12-22 16:48:25 +01:00
2021-03-23 23:13:35 +01:00
Change nested ifs to foreach with continue
2020-12-22 16:48:25 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\EarlyReturn\Rector\Foreach_\ChangeNestedForeachIfsToEarlyContinueRector` ](../rules/EarlyReturn/Rector/Foreach_/ChangeNestedForeachIfsToEarlyContinueRector.php )
2020-07-10 22:15:52 +02:00
2020-11-16 17:50:38 +00:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2020-11-16 17:50:38 +00:00
{
2020-11-25 22:34:34 +01:00
public function run()
2020-11-16 17:50:38 +00:00
{
2021-03-23 23:13:35 +01:00
$items = [];
foreach ($values as $value) {
- if ($value === 5) {
- if ($value2 === 10) {
- $items[] = 'maybe';
- }
+ if ($value !== 5) {
+ continue;
}
+ if ($value2 !== 10) {
+ continue;
+ }
+
+ $items[] = 'maybe';
}
2020-11-16 17:50:38 +00:00
}
}
```
2020-09-11 11:21:48 +02:00
2020-11-16 17:50:38 +00:00
< br >
2020-09-24 20:54:39 +02:00
2021-03-23 23:13:35 +01:00
### ChangeNestedIfsToEarlyReturnRector
2020-09-11 11:21:48 +02:00
2021-03-23 23:13:35 +01:00
Change nested ifs to early return
2020-09-24 20:54:39 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\EarlyReturn\Rector\If_\ChangeNestedIfsToEarlyReturnRector` ](../rules/EarlyReturn/Rector/If_/ChangeNestedIfsToEarlyReturnRector.php )
2020-11-16 17:50:38 +00:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
{
public function run()
{
2021-03-23 23:13:35 +01:00
- if ($value === 5) {
- if ($value2 === 10) {
- return 'yes';
- }
+ if ($value !== 5) {
+ return 'no';
+ }
+
+ if ($value2 === 10) {
+ return 'yes';
}
return 'no';
2020-11-25 22:34:34 +01:00
}
}
2020-09-11 11:21:48 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-09-11 11:21:48 +02:00
2021-03-23 23:13:35 +01:00
### ChangeOrIfContinueToMultiContinueRector
2020-11-16 17:50:38 +00:00
2021-06-06 07:59:41 +00:00
Changes if || to early return
2020-11-16 17:50:38 +00:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\EarlyReturn\Rector\If_\ChangeOrIfContinueToMultiContinueRector` ](../rules/EarlyReturn/Rector/If_/ChangeOrIfContinueToMultiContinueRector.php )
2020-09-10 09:27:03 +02:00
2020-11-16 17:50:38 +00:00
```diff
2020-08-01 13:41:16 +02:00
class SomeClass
{
2021-03-23 23:13:35 +01:00
public function canDrive(Car $newCar)
2020-09-10 09:27:03 +02:00
{
2021-03-23 23:13:35 +01:00
foreach ($cars as $car) {
- if ($car->hasWheels() || $car->hasFuel()) {
+ if ($car->hasWheels()) {
+ continue;
+ }
+ if ($car->hasFuel()) {
continue;
}
2020-11-16 17:50:38 +00:00
2021-03-23 23:13:35 +01:00
$car->setWheel($newCar->wheel);
$car->setFuel($newCar->fuel);
}
2020-09-10 09:27:03 +02:00
}
2020-07-10 22:15:52 +02:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-07-10 22:15:52 +02:00
2021-03-23 23:13:35 +01:00
### PreparedValueToEarlyReturnRector
2020-12-03 09:32:04 +01:00
2021-03-23 23:13:35 +01:00
Return early prepared value in ifs
2020-12-03 09:32:04 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\EarlyReturn\Rector\Return_\PreparedValueToEarlyReturnRector` ](../rules/EarlyReturn/Rector/Return_/PreparedValueToEarlyReturnRector.php )
2020-12-03 09:32:04 +01:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
2020-12-03 09:32:04 +01:00
{
2021-03-23 23:13:35 +01:00
public function run()
2021-03-01 13:10:50 +01:00
{
2021-03-23 23:13:35 +01:00
- $var = null;
-
2023-05-08 20:37:13 +00:00
if (rand(0, 1)) {
2021-03-23 23:13:35 +01:00
- $var = 1;
+ return 1;
}
2020-12-03 09:32:04 +01:00
2023-05-08 20:37:13 +00:00
if (rand(0, 1)) {
2021-03-23 23:13:35 +01:00
- $var = 2;
+ return 2;
}
- return $var;
+ return null;
2021-03-01 13:10:50 +01:00
}
2020-12-03 09:32:04 +01:00
}
```
< br >
2021-03-23 23:13:35 +01:00
### RemoveAlwaysElseRector
2020-12-22 16:48:25 +01:00
2021-03-23 23:13:35 +01:00
Split if statement, when if condition always break execution flow
2020-12-22 16:48:25 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\EarlyReturn\Rector\If_\RemoveAlwaysElseRector` ](../rules/EarlyReturn/Rector/If_/RemoveAlwaysElseRector.php )
2020-12-22 16:48:25 +01:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
{
public function run($value)
{
if ($value) {
throw new \InvalidStateException;
- } else {
- return 10;
}
+
+ return 10;
}
}
2020-12-22 16:48:25 +01:00
```
< br >
2021-03-23 23:13:35 +01:00
### ReturnBinaryOrToEarlyReturnRector
2021-01-12 12:52:10 +01:00
2021-03-23 23:13:35 +01:00
Changes Single return of || to early returns
2021-01-12 12:52:10 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\EarlyReturn\Rector\Return_\ReturnBinaryOrToEarlyReturnRector` ](../rules/EarlyReturn/Rector/Return_/ReturnBinaryOrToEarlyReturnRector.php )
2021-01-12 12:52:10 +01:00
```diff
2021-03-01 13:10:50 +01:00
class SomeClass
2021-01-12 12:52:10 +01:00
{
2021-03-23 23:13:35 +01:00
public function accept()
2021-01-12 12:52:10 +01:00
{
2021-03-23 23:13:35 +01:00
- return $this->something() || $this->somethingElse();
+ if ($this->something()) {
+ return true;
+ }
+ return (bool) $this->somethingElse();
2021-01-12 12:52:10 +01:00
}
}
```
< br >
2022-07-03 00:35:39 +00:00
### ReturnEarlyIfVariableRector
Replace if conditioned variable override with direct return
- class: [`Rector\EarlyReturn\Rector\StmtsAwareInterface\ReturnEarlyIfVariableRector` ](../rules/EarlyReturn/Rector/StmtsAwareInterface/ReturnEarlyIfVariableRector.php )
```diff
final class SomeClass
{
public function run($value)
{
if ($value === 50) {
- $value = 100;
+ return 100;
}
return $value;
}
}
```
< br >
2024-01-23 11:08:03 +00:00
## Instanceof
2023-08-06 00:29:06 +00:00
### FlipNegatedTernaryInstanceofRector
Flip negated ternary of instanceof to direct use of object
- class: [`Rector\Instanceof_\Rector\Ternary\FlipNegatedTernaryInstanceofRector` ](../rules/Instanceof_/Rector/Ternary/FlipNegatedTernaryInstanceofRector.php )
```diff
-echo ! $object instanceof Product ? null : $object->getPrice();
+echo $object instanceof Product ? $object->getPrice() : null;
```
< br >
2021-03-23 23:13:35 +01:00
## Naming
2020-12-22 16:48:25 +01:00
2021-03-23 23:13:35 +01:00
### RenameForeachValueVariableToMatchExprVariableRector
2020-12-22 16:48:25 +01:00
2021-03-23 23:13:35 +01:00
Renames value variable name in foreach loop to match expression variable
2020-12-22 16:48:25 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Naming\Rector\Foreach_\RenameForeachValueVariableToMatchExprVariableRector` ](../rules/Naming/Rector/Foreach_/RenameForeachValueVariableToMatchExprVariableRector.php )
2020-12-22 16:48:25 +01:00
```diff
class SomeClass
{
2022-07-24 00:40:22 +00:00
public function run()
{
$array = [];
- foreach ($variables as $property) {
- $array[] = $property;
+ foreach ($variables as $variable) {
+ $array[] = $variable;
}
2020-12-22 16:48:25 +01:00
}
}
```
< br >
2021-03-23 23:13:35 +01:00
### RenameForeachValueVariableToMatchMethodCallReturnTypeRector
2020-09-24 20:54:39 +02:00
2021-03-23 23:13:35 +01:00
Renames value variable name in foreach loop to match method type
2020-08-30 14:45:03 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Naming\Rector\Foreach_\RenameForeachValueVariableToMatchMethodCallReturnTypeRector` ](../rules/Naming/Rector/Foreach_/RenameForeachValueVariableToMatchMethodCallReturnTypeRector.php )
2020-02-23 18:20:00 +01:00
2020-11-16 17:50:38 +00:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
{
2021-03-23 23:13:35 +01:00
public function run()
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
$array = [];
- foreach ($object->getMethods() as $property) {
- $array[] = $property;
+ foreach ($object->getMethods() as $method) {
+ $array[] = $method;
}
2020-11-25 22:34:34 +01:00
}
2020-11-16 17:50:38 +00:00
}
```
2020-08-12 11:44:34 +02:00
2020-11-16 17:50:38 +00:00
< br >
2020-08-12 11:44:34 +02:00
2021-03-23 23:13:35 +01:00
### RenameParamToMatchTypeRector
2019-09-19 11:27:29 +02:00
2021-06-06 07:59:41 +00:00
Rename param to match ClassType
2019-09-19 11:27:29 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Naming\Rector\ClassMethod\RenameParamToMatchTypeRector` ](../rules/Naming/Rector/ClassMethod/RenameParamToMatchTypeRector.php )
2019-09-19 11:27:29 +02:00
2020-12-22 16:48:25 +01:00
```diff
2021-03-23 23:13:35 +01:00
final class SomeClass
2020-12-22 16:48:25 +01:00
{
2021-03-23 23:13:35 +01:00
- public function run(Apple $pie)
+ public function run(Apple $apple)
2020-12-22 16:48:25 +01:00
{
2021-03-23 23:13:35 +01:00
- $food = $pie;
+ $food = $apple;
2020-12-22 16:48:25 +01:00
}
}
```
2020-11-25 22:34:34 +01:00
2020-12-22 16:48:25 +01:00
< br >
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
### RenamePropertyToMatchTypeRector
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
Rename property and method param to match its type
2020-12-22 16:48:25 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Naming\Rector\Class_\RenamePropertyToMatchTypeRector` ](../rules/Naming/Rector/Class_/RenamePropertyToMatchTypeRector.php )
2020-11-25 22:34:34 +01:00
```diff
2020-12-22 16:48:25 +01:00
class SomeClass
{
2021-03-23 23:13:35 +01:00
/**
* @var EntityManager
*/
- private $eventManager;
+ private $entityManager;
- public function __construct(EntityManager $eventManager)
+ public function __construct(EntityManager $entityManager)
2020-12-22 16:48:25 +01:00
{
2021-03-23 23:13:35 +01:00
- $this->eventManager = $eventManager;
+ $this->entityManager = $entityManager;
2020-12-22 16:48:25 +01:00
}
}
2020-11-16 17:50:38 +00:00
```
2020-09-24 20:54:39 +02:00
2020-11-16 17:50:38 +00:00
< br >
2019-06-02 10:45:37 +03:00
2021-03-23 23:13:35 +01:00
### RenameVariableToMatchMethodCallReturnTypeRector
2019-06-02 10:45:37 +03:00
2021-03-23 23:13:35 +01:00
Rename variable to match method return type
2019-06-02 10:45:37 +03:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Naming\Rector\Assign\RenameVariableToMatchMethodCallReturnTypeRector` ](../rules/Naming/Rector/Assign/RenameVariableToMatchMethodCallReturnTypeRector.php )
2019-03-09 13:24:30 +00:00
2020-11-25 22:34:34 +01:00
```diff
2020-12-22 16:48:25 +01:00
class SomeClass
2020-11-16 17:50:38 +00:00
{
2023-05-28 00:32:17 +00:00
public function run()
{
- $a = $this->getRunner();
+ $runner = $this->getRunner();
}
2020-12-22 16:48:25 +01:00
2023-05-28 00:32:17 +00:00
public function getRunner(): Runner
{
return new Runner();
}
2020-11-16 17:50:38 +00:00
}
```
2020-09-24 20:54:39 +02:00
2020-11-16 17:50:38 +00:00
< br >
2019-03-09 13:24:30 +00:00
2021-03-23 23:13:35 +01:00
### RenameVariableToMatchNewTypeRector
2020-09-24 20:54:39 +02:00
2021-03-23 23:13:35 +01:00
Rename variable to match new ClassType
2019-03-09 13:24:30 +00:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Naming\Rector\ClassMethod\RenameVariableToMatchNewTypeRector` ](../rules/Naming/Rector/ClassMethod/RenameVariableToMatchNewTypeRector.php )
2019-03-09 13:24:30 +00:00
2020-12-22 16:48:25 +01:00
```diff
2021-03-23 23:13:35 +01:00
final class SomeClass
2020-12-22 16:48:25 +01:00
{
public function run()
{
2021-03-23 23:13:35 +01:00
- $search = new DreamSearch();
- $search->advance();
+ $dreamSearch = new DreamSearch();
+ $dreamSearch->advance();
2021-02-21 00:21:19 +01:00
}
}
2020-05-29 12:41:25 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-05-24 10:46:34 +02:00
2021-03-23 23:13:35 +01:00
## Php52
### ContinueToBreakInSwitchRector
2018-11-11 13:22:35 +01:00
2021-03-23 23:13:35 +01:00
Use break instead of continue in switch statements
2018-11-11 13:22:35 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php52\Rector\Switch_\ContinueToBreakInSwitchRector` ](../rules/Php52/Rector/Switch_/ContinueToBreakInSwitchRector.php )
2018-11-11 13:22:35 +01:00
```diff
2021-03-23 23:13:35 +01:00
function some_run($value)
2020-11-16 17:50:38 +00:00
{
2021-03-23 23:13:35 +01:00
switch ($value) {
case 1:
echo 'Hi';
- continue;
+ break;
case 2:
echo 'Hello';
break;
2020-11-25 22:34:34 +01:00
}
2020-07-29 01:41:20 +02:00
}
2018-11-11 13:22:35 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2021-03-23 23:13:35 +01:00
### VarToPublicPropertyRector
2020-11-16 17:50:38 +00:00
2021-06-06 07:59:41 +00:00
Change property modifier from `var` to `public`
2020-11-16 17:50:38 +00:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php52\Rector\Property\VarToPublicPropertyRector` ](../rules/Php52/Rector/Property/VarToPublicPropertyRector.php )
2018-11-11 13:22:35 +01:00
2020-11-25 22:34:34 +01:00
```diff
2021-03-23 23:13:35 +01:00
final class SomeController
{
- var $name = 'Tom';
+ public $name = 'Tom';
}
2020-11-25 22:34:34 +01:00
```
2020-11-04 11:45:10 +07:00
2020-11-25 22:34:34 +01:00
< br >
2020-11-04 11:45:10 +07:00
2021-03-23 23:13:35 +01:00
## Php53
### DirNameFileConstantToDirConstantRector
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
Convert dirname(__FILE__) to __DIR__
2020-11-25 22:34:34 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector` ](../rules/Php53/Rector/FuncCall/DirNameFileConstantToDirConstantRector.php )
2020-11-25 22:34:34 +01:00
```diff
class SomeClass
2019-08-05 23:10:47 +02:00
{
2020-11-25 22:34:34 +01:00
public function run()
{
2021-03-23 23:13:35 +01:00
- return dirname(__FILE__);
+ return __DIR__ ;
2020-11-25 22:34:34 +01:00
}
2019-08-05 23:10:47 +02:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2019-10-15 16:46:31 +02:00
2021-03-23 23:13:35 +01:00
### ReplaceHttpServerVarsByServerRector
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
Rename old `$HTTP_*` variable names to new replacements
2020-11-25 22:34:34 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php53\Rector\Variable\ReplaceHttpServerVarsByServerRector` ](../rules/Php53/Rector/Variable/ReplaceHttpServerVarsByServerRector.php )
2020-04-01 02:05:51 +02:00
```diff
2021-03-23 23:13:35 +01:00
-$serverVars = $HTTP_SERVER_VARS;
+$serverVars = $_SERVER;
2020-04-01 02:05:51 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-04-01 02:05:51 +02:00
2021-03-23 23:13:35 +01:00
### TernaryToElvisRector
2019-09-06 12:30:58 +02:00
2021-03-23 23:13:35 +01:00
Use ?: instead of ?, where useful
2019-09-06 12:30:58 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php53\Rector\Ternary\TernaryToElvisRector` ](../rules/Php53/Rector/Ternary/TernaryToElvisRector.php )
2019-09-06 12:30:58 +02:00
```diff
2021-03-23 23:13:35 +01:00
function elvis()
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
- $value = $a ? $a : false;
+ $value = $a ?: false;
2019-09-06 12:30:58 +02:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2019-09-06 12:30:58 +02:00
2021-03-23 23:13:35 +01:00
## Php54
2022-07-03 23:03:40 +00:00
### LongArrayToShortArrayRector
2022-07-03 11:40:45 +00:00
2022-07-03 23:03:40 +00:00
Long array to short array
2022-07-03 11:40:45 +00:00
2022-07-03 23:03:40 +00:00
- class: [`Rector\Php54\Rector\Array_\LongArrayToShortArrayRector` ](../rules/Php54/Rector/Array_/LongArrayToShortArrayRector.php )
2022-07-03 11:40:45 +00:00
```diff
class SomeClass
{
public function run()
{
- return array();
+ return [];
}
}
```
< br >
2021-03-23 23:13:35 +01:00
### RemoveReferenceFromCallRector
2021-01-01 19:59:23 +01:00
2021-03-23 23:13:35 +01:00
Remove & from function and method calls
2021-01-01 19:59:23 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php54\Rector\FuncCall\RemoveReferenceFromCallRector` ](../rules/Php54/Rector/FuncCall/RemoveReferenceFromCallRector.php )
2021-01-01 19:59:23 +01:00
```diff
2021-03-23 23:13:35 +01:00
final class SomeClass
2021-01-01 19:59:23 +01:00
{
2021-03-23 23:13:35 +01:00
public function run($one)
2021-01-01 19:59:23 +01:00
{
2021-03-23 23:13:35 +01:00
- return strlen(&$one);
+ return strlen($one);
2021-01-01 19:59:23 +01:00
}
}
```
< br >
2021-03-23 23:13:35 +01:00
### RemoveZeroBreakContinueRector
2020-08-04 00:21:59 +02:00
2021-03-23 23:13:35 +01:00
Remove 0 from break and continue
2020-08-04 00:21:59 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php54\Rector\Break_\RemoveZeroBreakContinueRector` ](../rules/Php54/Rector/Break_/RemoveZeroBreakContinueRector.php )
2020-08-04 00:21:59 +02:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
public function run($random)
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
- continue 0;
- break 0;
+ continue;
+ break;
$five = 5;
- continue $five;
+ continue 5;
- break $random;
+ break;
2020-11-25 22:34:34 +01:00
}
}
2020-08-04 00:21:59 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-08-04 00:21:59 +02:00
2021-03-23 23:13:35 +01:00
## Php55
### ClassConstantToSelfClassRector
2020-10-31 01:43:54 +01:00
2021-03-23 23:13:35 +01:00
Change `__CLASS__` to self::class
2020-10-31 01:43:54 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php55\Rector\Class_\ClassConstantToSelfClassRector` ](../rules/Php55/Rector/Class_/ClassConstantToSelfClassRector.php )
2020-10-31 01:43:54 +01:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
{
2021-03-23 23:13:35 +01:00
public function callOnMe()
{
- var_dump(__CLASS__);
+ var_dump(self::class);
}
2020-10-31 01:43:54 +01:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-10-31 01:43:54 +01:00
2022-03-28 09:17:08 +00:00
### GetCalledClassToSelfClassRector
Change `get_called_class()` to self::class on final class
- class: [`Rector\Php55\Rector\FuncCall\GetCalledClassToSelfClassRector` ](../rules/Php55/Rector/FuncCall/GetCalledClassToSelfClassRector.php )
```diff
final class SomeClass
{
public function callOnMe()
{
- var_dump(get_called_class());
+ var_dump(self::class);
}
}
```
< br >
### GetCalledClassToStaticClassRector
Change `get_called_class()` to static::class on non-final class
- class: [`Rector\Php55\Rector\FuncCall\GetCalledClassToStaticClassRector` ](../rules/Php55/Rector/FuncCall/GetCalledClassToStaticClassRector.php )
```diff
class SomeClass
{
public function callOnMe()
{
- var_dump(get_called_class());
+ var_dump(static::class);
}
}
```
< br >
2021-03-23 23:13:35 +01:00
### PregReplaceEModifierRector
2018-10-22 00:26:45 +02:00
2021-04-10 20:18:49 +02:00
The /e modifier is no longer supported, use preg_replace_callback instead
2018-10-22 00:26:45 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php55\Rector\FuncCall\PregReplaceEModifierRector` ](../rules/Php55/Rector/FuncCall/PregReplaceEModifierRector.php )
2018-07-31 21:43:39 +02:00
2019-06-02 10:45:37 +03:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2020-11-16 17:50:38 +00:00
{
2020-11-25 22:34:34 +01:00
public function run()
{
2021-03-23 23:13:35 +01:00
- $comment = preg_replace('~\b(\w)(\w+)~e', '"$1".strtolower("$2")', $comment);
+ $comment = preg_replace_callback('~\b(\w)(\w+)~', function ($matches) {
+ return($matches[1].strtolower($matches[2]));
2021-08-01 00:25:55 +00:00
+ }, $comment);
2020-11-25 22:34:34 +01:00
}
2020-07-29 01:41:20 +02:00
}
2018-12-14 20:35:35 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-12-14 20:35:35 +01:00
2023-04-19 07:12:58 +00:00
### StaticToSelfOnFinalClassRector
Change `static::class` to `self::class` on final class
- class: [`Rector\Php55\Rector\ClassConstFetch\StaticToSelfOnFinalClassRector` ](../rules/Php55/Rector/ClassConstFetch/StaticToSelfOnFinalClassRector.php )
```diff
final class SomeClass
{
public function callOnMe()
{
- var_dump(static::class);
+ var_dump(self::class);
}
}
```
< br >
2021-03-23 23:13:35 +01:00
### StringClassNameToClassConstantRector
2020-10-30 18:10:17 +01:00
2021-03-23 23:13:35 +01:00
Replace string class names by < class > ::class constant
2020-10-30 18:10:17 +01:00
2021-03-23 23:13:35 +01:00
:wrench: **configure it!**
2020-10-30 18:10:17 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php55\Rector\String_\StringClassNameToClassConstantRector` ](../rules/Php55/Rector/String_/StringClassNameToClassConstantRector.php )
2020-11-16 17:50:38 +00:00
2021-03-13 00:52:38 +01:00
```diff
2021-03-23 23:13:35 +01:00
class AnotherClass
2021-03-13 00:52:38 +01:00
{
}
2020-11-25 22:34:34 +01:00
class SomeClass
{
2021-03-23 23:13:35 +01:00
public function run()
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
- return 'AnotherClass';
+ return \AnotherClass::class;
2020-11-25 22:34:34 +01:00
}
}
2020-10-09 22:01:37 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-10-09 22:01:37 +02:00
2021-03-23 23:13:35 +01:00
## Php56
### PowToExpRector
2019-05-29 15:40:20 +02:00
2021-04-10 20:18:49 +02:00
Changes pow(val, val2) to ** (exp) parameter
2018-12-14 20:35:35 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php56\Rector\FuncCall\PowToExpRector` ](../rules/Php56/Rector/FuncCall/PowToExpRector.php )
2018-12-14 20:35:35 +01:00
```diff
2021-03-23 23:13:35 +01:00
-pow(1, 2);
+1**2;
2019-03-16 21:31:46 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-03-16 21:31:46 +01:00
2021-03-23 23:13:35 +01:00
## Php70
### BreakNotInLoopOrSwitchToReturnRector
2019-05-29 15:40:20 +02:00
2021-03-23 23:13:35 +01:00
Convert break outside for/foreach/switch context to return
2019-05-29 15:40:20 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php70\Rector\Break_\BreakNotInLoopOrSwitchToReturnRector` ](../rules/Php70/Rector/Break_/BreakNotInLoopOrSwitchToReturnRector.php )
2019-05-29 15:40:20 +02:00
2019-06-02 10:45:37 +03:00
```diff
2020-07-29 01:41:20 +02:00
class SomeClass
{
public function run()
{
2021-03-23 23:13:35 +01:00
if ($isphp5)
return 1;
else
return 2;
- break;
+ return;
2020-07-29 01:41:20 +02:00
}
}
2019-05-29 15:40:20 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-05-29 15:40:20 +02:00
2021-03-23 23:13:35 +01:00
### CallUserMethodRector
2019-03-16 21:31:46 +01:00
2021-03-23 23:13:35 +01:00
Changes `call_user_method()/call_user_method_array()` to `call_user_func()/call_user_func_array()`
2019-03-16 21:31:46 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php70\Rector\FuncCall\CallUserMethodRector` ](../rules/Php70/Rector/FuncCall/CallUserMethodRector.php )
2019-02-04 01:32:53 +01:00
2018-08-01 22:09:34 +02:00
```diff
2021-03-23 23:13:35 +01:00
-call_user_method($method, $obj, "arg1", "arg2");
+call_user_func(array(& $obj, "method"), "arg1", "arg2");
2018-07-31 14:50:39 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-07-31 21:43:39 +02:00
2021-03-23 23:13:35 +01:00
### EmptyListRector
2018-07-31 14:50:39 +02:00
2021-03-23 23:13:35 +01:00
`list()` cannot be empty
2018-07-31 14:50:39 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php70\Rector\List_\EmptyListRector` ](../rules/Php70/Rector/List_/EmptyListRector.php )
2018-07-31 14:50:39 +02:00
2018-08-01 22:09:34 +02:00
```diff
2021-03-23 23:13:35 +01:00
-'list() = $values;'
+'list($unusedGenerated) = $values;'
2018-10-12 20:15:00 -03:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-07-31 14:50:39 +02:00
2021-03-23 23:13:35 +01:00
### EregToPregMatchRector
2020-07-29 10:33:10 +02:00
2021-03-23 23:13:35 +01:00
Changes ereg*() to preg*() calls
2020-07-29 10:33:10 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php70\Rector\FuncCall\EregToPregMatchRector` ](../rules/Php70/Rector/FuncCall/EregToPregMatchRector.php )
2020-07-29 10:33:10 +02:00
```diff
2021-03-23 23:13:35 +01:00
-ereg("hi")
+preg_match("#hi #");
2020-07-29 10:33:10 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-07-29 10:33:10 +02:00
2021-03-23 23:13:35 +01:00
### ExceptionHandlerTypehintRector
2020-08-02 00:18:40 +02:00
2021-06-06 07:59:41 +00:00
Change typehint from `Exception` to `Throwable` .
2020-08-02 00:18:40 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php70\Rector\FunctionLike\ExceptionHandlerTypehintRector` ](../rules/Php70/Rector/FunctionLike/ExceptionHandlerTypehintRector.php )
2020-11-25 22:34:34 +01:00
```diff
2021-03-23 23:13:35 +01:00
-function handler(Exception $exception) { ... }
+function handler(Throwable $exception) { ... }
set_exception_handler('handler');
2020-08-02 00:18:40 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-08-02 00:18:40 +02:00
2023-05-17 09:47:50 +00:00
### IfIssetToCoalescingRector
2020-08-02 00:18:40 +02:00
2023-05-17 09:47:50 +00:00
Change if with isset and return to coalesce
2020-08-02 00:18:40 +02:00
2023-05-17 09:47:50 +00:00
- class: [`Rector\Php70\Rector\StmtsAwareInterface\IfIssetToCoalescingRector` ](../rules/Php70/Rector/StmtsAwareInterface/IfIssetToCoalescingRector.php )
2020-08-02 00:18:40 +02:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
2020-08-02 00:18:40 +02:00
{
2023-05-17 09:47:50 +00:00
private $items = [];
public function resolve($key)
2020-08-02 00:18:40 +02:00
{
2023-05-17 09:47:50 +00:00
- if (isset($this->items[$key])) {
- return $this->items[$key];
- }
2021-03-23 23:13:35 +01:00
-
2023-05-17 09:47:50 +00:00
- return 'fallback value';
+ return $this->items[$key] ?? 'fallback value';
2020-08-02 00:18:40 +02:00
}
2020-11-25 22:34:34 +01:00
}
2020-08-02 00:18:40 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-08-02 00:18:40 +02:00
2023-05-17 09:47:50 +00:00
### IfToSpaceshipRector
Changes if/else to spaceship < => where useful
- class: [`Rector\Php70\Rector\If_\IfToSpaceshipRector` ](../rules/Php70/Rector/If_/IfToSpaceshipRector.php )
```diff
usort($languages, function ($first, $second) {
-if ($first[0] === $second[0]) {
- return 0;
-}
-
-return ($first[0] < $second[0]) ? 1 : -1;
+return $second[0] < => $first[0];
});
```
< br >
2021-03-23 23:13:35 +01:00
### ListSplitStringRector
2018-11-11 13:22:35 +01:00
2021-03-23 23:13:35 +01:00
`list()` cannot split string directly anymore, use `str_split()`
2018-10-12 20:15:00 -03:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php70\Rector\Assign\ListSplitStringRector` ](../rules/Php70/Rector/Assign/ListSplitStringRector.php )
2018-10-12 20:15:00 -03:00
2018-11-11 13:22:35 +01:00
```diff
2021-03-23 23:13:35 +01:00
-list($foo) = "string";
+list($foo) = str_split("string");
2018-11-11 13:22:35 +01:00
```
2018-10-12 20:15:00 -03:00
2020-11-16 17:50:38 +00:00
< br >
2018-10-22 00:26:45 +02:00
2021-03-23 23:13:35 +01:00
### ListSwapArrayOrderRector
2018-11-11 13:22:35 +01:00
2021-03-23 23:13:35 +01:00
`list()` assigns variables in reverse order - relevant in array assign
2018-11-11 13:22:35 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php70\Rector\Assign\ListSwapArrayOrderRector` ](../rules/Php70/Rector/Assign/ListSwapArrayOrderRector.php )
2018-10-12 20:15:00 -03:00
```diff
2021-03-23 23:13:35 +01:00
-list($a[], $a[]) = [1, 2];
+list($a[], $a[]) = array_reverse([1, 2]);
2020-11-25 22:34:34 +01:00
```
2018-10-12 20:15:00 -03:00
2020-11-25 22:34:34 +01:00
< br >
2018-10-12 20:15:00 -03:00
2021-03-23 23:13:35 +01:00
### MultiDirnameRector
2018-10-12 20:15:00 -03:00
2021-03-23 23:13:35 +01:00
Changes multiple `dirname()` calls to one with nesting level
2018-10-12 20:15:00 -03:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php70\Rector\FuncCall\MultiDirnameRector` ](../rules/Php70/Rector/FuncCall/MultiDirnameRector.php )
2020-07-29 01:41:20 +02:00
2020-11-25 22:34:34 +01:00
```diff
2021-03-23 23:13:35 +01:00
-dirname(dirname($path));
+dirname($path, 2);
```
2020-07-29 01:41:20 +02:00
2021-03-23 23:13:35 +01:00
< br >
2018-10-12 20:15:00 -03:00
2021-03-23 23:13:35 +01:00
### Php4ConstructorRector
2021-02-13 15:57:30 +01:00
2021-03-23 23:13:35 +01:00
Changes PHP 4 style constructor to __construct.
2021-02-13 15:57:30 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php70\Rector\ClassMethod\Php4ConstructorRector` ](../rules/Php70/Rector/ClassMethod/Php4ConstructorRector.php )
2021-02-13 15:57:30 +01:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
2021-02-13 15:57:30 +01:00
{
2021-03-23 23:13:35 +01:00
- public function SomeClass()
+ public function __construct()
2021-02-13 15:57:30 +01:00
{
}
}
```
< br >
2021-03-23 23:13:35 +01:00
### RandomFunctionRector
2018-11-11 13:22:35 +01:00
2023-12-04 14:56:20 +00:00
Changes rand, srand, and getrandmax to newer alternatives
2018-10-12 20:15:00 -03:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php70\Rector\FuncCall\RandomFunctionRector` ](../rules/Php70/Rector/FuncCall/RandomFunctionRector.php )
2018-10-12 20:15:00 -03:00
```diff
2021-03-23 23:13:35 +01:00
-rand();
2023-05-14 00:32:54 +00:00
+random_int();
2018-11-11 13:22:35 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-11-11 13:22:35 +01:00
2021-03-23 23:13:35 +01:00
### ReduceMultipleDefaultSwitchRector
2020-11-27 13:00:56 +01:00
2021-03-23 23:13:35 +01:00
Remove first default switch, that is ignored
2020-11-27 13:00:56 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php70\Rector\Switch_\ReduceMultipleDefaultSwitchRector` ](../rules/Php70/Rector/Switch_/ReduceMultipleDefaultSwitchRector.php )
2020-11-27 13:00:56 +01:00
```diff
2021-03-23 23:13:35 +01:00
switch ($expr) {
default:
- echo "Hello World";
-
- default:
echo "Goodbye Moon!";
break;
}
2020-11-27 13:00:56 +01:00
```
< br >
2021-03-23 23:13:35 +01:00
### RenameMktimeWithoutArgsToTimeRector
2018-11-11 13:22:35 +01:00
2021-03-23 23:13:35 +01:00
Renames `mktime()` without arguments to `time()`
2018-11-11 13:22:35 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php70\Rector\FuncCall\RenameMktimeWithoutArgsToTimeRector` ](../rules/Php70/Rector/FuncCall/RenameMktimeWithoutArgsToTimeRector.php )
2020-07-29 01:41:20 +02:00
2020-11-25 22:34:34 +01:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
public function run()
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
$time = mktime(1, 2, 3);
- $nextTime = mktime();
+ $nextTime = time();
2020-11-25 22:34:34 +01:00
}
}
2020-11-16 17:50:38 +00:00
```
2020-11-25 22:34:34 +01:00
< br >
2021-03-23 23:13:35 +01:00
### StaticCallOnNonStaticToInstanceCallRector
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
Changes static call to instance call, where not useful
2020-11-25 22:34:34 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php70\Rector\StaticCall\StaticCallOnNonStaticToInstanceCallRector` ](../rules/Php70/Rector/StaticCall/StaticCallOnNonStaticToInstanceCallRector.php )
2020-07-29 01:41:20 +02:00
2020-11-16 17:50:38 +00:00
```diff
2021-03-23 23:13:35 +01:00
class Something
2020-11-16 17:50:38 +00:00
{
2021-03-23 23:13:35 +01:00
public function doWork()
2020-11-25 22:34:34 +01:00
{
}
2021-03-23 23:13:35 +01:00
}
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
class Another
{
2020-07-29 01:41:20 +02:00
public function run()
{
2021-03-23 23:13:35 +01:00
- return Something::doWork();
+ return (new Something)->doWork();
2020-07-29 01:41:20 +02:00
}
}
2018-10-12 20:15:00 -03:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-03-23 17:13:04 +01:00
2021-03-23 23:13:35 +01:00
### TernaryToNullCoalescingRector
2018-10-12 20:15:00 -03:00
2021-03-23 23:13:35 +01:00
Changes unneeded null check to ?? operator
2018-10-12 20:15:00 -03:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php70\Rector\Ternary\TernaryToNullCoalescingRector` ](../rules/Php70/Rector/Ternary/TernaryToNullCoalescingRector.php )
2019-05-29 15:40:20 +02:00
```diff
2021-03-23 23:13:35 +01:00
-$value === null ? 10 : $value;
+$value ?? 10;
2019-10-15 16:46:31 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-10-15 16:46:31 +02:00
2021-03-23 23:13:35 +01:00
```diff
-isset($value) ? $value : 10;
+$value ?? 10;
```
2021-01-01 19:59:23 +01:00
2021-03-23 23:13:35 +01:00
< br >
2021-01-01 19:59:23 +01:00
2021-03-23 23:13:35 +01:00
### TernaryToSpaceshipRector
2021-01-01 19:59:23 +01:00
2021-03-23 23:13:35 +01:00
Use < => spaceship instead of ternary with same effect
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php70\Rector\Ternary\TernaryToSpaceshipRector` ](../rules/Php70/Rector/Ternary/TernaryToSpaceshipRector.php )
2021-03-23 23:13:35 +01:00
```diff
function order_func($a, $b) {
- return ($a < $b) ? -1 : (($a > $b) ? 1 : 0);
+ return $a < => $b;
}
```
< br >
### ThisCallOnStaticMethodToStaticCallRector
Changes `$this->call()` to static method to static call
2021-01-01 19:59:23 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php70\Rector\MethodCall\ThisCallOnStaticMethodToStaticCallRector` ](../rules/Php70/Rector/MethodCall/ThisCallOnStaticMethodToStaticCallRector.php )
2021-03-23 23:13:35 +01:00
```diff
class SomeClass
2021-01-01 19:59:23 +01:00
{
2021-03-23 23:13:35 +01:00
public static function run()
2021-01-01 19:59:23 +01:00
{
2021-03-23 23:13:35 +01:00
- $this->eat();
+ static::eat();
2021-01-01 19:59:23 +01:00
}
2021-03-23 23:13:35 +01:00
public static function eat()
2021-01-01 19:59:23 +01:00
{
}
}
```
< br >
2021-03-23 23:13:35 +01:00
### WrapVariableVariableNameInCurlyBracesRector
2018-10-12 20:15:00 -03:00
2021-03-23 23:13:35 +01:00
Ensure variable variables are wrapped in curly braces
2020-11-25 22:34:34 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php70\Rector\Variable\WrapVariableVariableNameInCurlyBracesRector` ](../rules/Php70/Rector/Variable/WrapVariableVariableNameInCurlyBracesRector.php )
2019-05-29 15:40:20 +02:00
```diff
2021-03-23 23:13:35 +01:00
function run($foo)
2020-01-31 15:26:54 +01:00
{
2021-03-23 23:13:35 +01:00
- global $$foo->bar;
+ global ${$foo->bar};
2020-11-16 17:50:38 +00:00
}
2020-01-31 15:26:54 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-01-31 15:26:54 +01:00
2021-03-23 23:13:35 +01:00
## Php71
2020-01-17 01:16:38 +01:00
2021-03-23 23:13:35 +01:00
### AssignArrayToStringRector
2020-01-17 01:16:38 +01:00
2021-03-23 23:13:35 +01:00
String cannot be turned into array by assignment anymore
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php71\Rector\Assign\AssignArrayToStringRector` ](../rules/Php71/Rector/Assign/AssignArrayToStringRector.php )
2020-01-17 01:16:38 +01:00
```diff
2021-03-23 23:13:35 +01:00
-$string = '';
+$string = [];
$string[] = 1;
```
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
< br >
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
### BinaryOpBetweenNumberAndStringRector
Change binary operation between some number + string to PHP 7.1 compatible version
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php71\Rector\BinaryOp\BinaryOpBetweenNumberAndStringRector` ](../rules/Php71/Rector/BinaryOp/BinaryOpBetweenNumberAndStringRector.php )
2021-03-23 23:13:35 +01:00
```diff
class SomeClass
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
public function run()
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
- $value = 5 + '';
- $value = 5.0 + 'hi';
+ $value = 5 + 0;
2021-08-01 00:25:55 +00:00
+ $value = 5.0 + 0;
2020-11-25 22:34:34 +01:00
}
2021-03-23 23:13:35 +01:00
}
2020-01-17 01:16:38 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-01-17 01:16:38 +01:00
2021-03-23 23:13:35 +01:00
### IsIterableRector
2019-10-15 16:46:31 +02:00
2021-04-10 20:18:49 +02:00
Changes is_array + Traversable check to is_iterable
2020-11-25 22:34:34 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php71\Rector\BooleanOr\IsIterableRector` ](../rules/Php71/Rector/BooleanOr/IsIterableRector.php )
2019-10-15 16:46:31 +02:00
```diff
2021-03-23 23:13:35 +01:00
-is_array($foo) || $foo instanceof Traversable;
+is_iterable($foo);
2019-10-15 16:46:31 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-10-01 23:55:10 +07:00
2021-03-23 23:13:35 +01:00
### ListToArrayDestructRector
2020-01-17 01:16:38 +01:00
2021-05-30 07:54:06 +00:00
Change `list()` to array destruct
2020-01-17 01:16:38 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php71\Rector\List_\ListToArrayDestructRector` ](../rules/Php71/Rector/List_/ListToArrayDestructRector.php )
2020-11-16 17:50:38 +00:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
public function run()
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
- list($id1, $name1) = $data;
+ [$id1, $name1] = $data;
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
- foreach ($data as list($id, $name)) {
+ foreach ($data as [$id, $name]) {
}
2020-11-25 22:34:34 +01:00
}
}
2020-11-16 17:50:38 +00:00
```
2020-01-17 01:16:38 +01:00
2021-03-23 23:13:35 +01:00
< br >
2019-05-29 15:40:20 +02:00
2021-03-23 23:13:35 +01:00
### MultiExceptionCatchRector
2019-05-29 15:40:20 +02:00
2021-03-23 23:13:35 +01:00
Changes multi catch of same exception to single one | separated.
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php71\Rector\TryCatch\MultiExceptionCatchRector` ](../rules/Php71/Rector/TryCatch/MultiExceptionCatchRector.php )
2021-03-23 23:13:35 +01:00
```diff
try {
2021-08-01 00:25:55 +00:00
// Some code...
2021-03-23 23:13:35 +01:00
-} catch (ExceptionType1 $exception) {
- $sameCode;
-} catch (ExceptionType2 $exception) {
+} catch (ExceptionType1 | ExceptionType2 $exception) {
2021-08-01 00:25:55 +00:00
$sameCode;
2021-03-23 23:13:35 +01:00
}
2020-11-25 22:34:34 +01:00
```
2019-05-29 15:40:20 +02:00
2020-11-25 22:34:34 +01:00
< br >
2019-05-29 15:40:20 +02:00
2021-03-23 23:13:35 +01:00
### PublicConstantVisibilityRector
2019-03-31 14:25:39 +02:00
2021-03-23 23:13:35 +01:00
Add explicit public constant visibility.
2019-05-29 15:40:20 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php71\Rector\ClassConst\PublicConstantVisibilityRector` ](../rules/Php71/Rector/ClassConst/PublicConstantVisibilityRector.php )
2019-05-29 15:40:20 +02:00
2020-11-25 22:34:34 +01:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
- const HEY = 'you';
+ public const HEY = 'you';
2020-11-25 22:34:34 +01:00
}
2020-11-16 17:50:38 +00:00
```
2019-05-29 15:40:20 +02:00
2020-11-25 22:34:34 +01:00
< br >
2021-03-23 23:13:35 +01:00
### RemoveExtraParametersRector
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
Remove extra parameters
2020-11-25 22:34:34 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php71\Rector\FuncCall\RemoveExtraParametersRector` ](../rules/Php71/Rector/FuncCall/RemoveExtraParametersRector.php )
2019-05-29 15:40:20 +02:00
```diff
2021-03-23 23:13:35 +01:00
-strlen("asdf", 1);
+strlen("asdf");
2019-03-31 14:25:39 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-03-31 14:25:39 +02:00
2021-03-23 23:13:35 +01:00
## Php72
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
### CreateFunctionToAnonymousFunctionRector
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
Use anonymous functions instead of deprecated `create_function()`
2019-11-29 14:19:49 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php72\Rector\FuncCall\CreateFunctionToAnonymousFunctionRector` ](../rules/Php72/Rector/FuncCall/CreateFunctionToAnonymousFunctionRector.php )
2020-07-29 01:41:20 +02:00
2021-03-23 23:13:35 +01:00
```diff
class ClassWithCreateFunction
2020-07-29 01:41:20 +02:00
{
2021-03-23 23:13:35 +01:00
public function run()
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
- $callable = create_function('$matches', "return '$delimiter' . strtolower(\$matches[1]);");
+ $callable = function($matches) use ($delimiter) {
+ return $delimiter . strtolower($matches[1]);
+ };
2020-11-25 22:34:34 +01:00
}
2019-11-29 14:19:49 +01:00
}
2018-10-12 20:15:00 -03:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-11-11 13:22:35 +01:00
2021-03-23 23:13:35 +01:00
### GetClassOnNullRector
2019-01-22 21:34:38 +01:00
2021-03-23 23:13:35 +01:00
Null is no more allowed in `get_class()`
2019-01-22 21:34:38 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php72\Rector\FuncCall\GetClassOnNullRector` ](../rules/Php72/Rector/FuncCall/GetClassOnNullRector.php )
2019-01-22 21:34:38 +01:00
```diff
2021-03-23 23:13:35 +01:00
final class SomeClass
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
public function getItem()
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
$value = null;
- return get_class($value);
+ return $value !== null ? get_class($value) : self::class;
2020-11-25 22:34:34 +01:00
}
}
2019-01-22 21:34:38 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-01-22 21:34:38 +01:00
2021-03-23 23:13:35 +01:00
### ListEachRector
2018-12-14 20:35:35 +01:00
2021-03-23 23:13:35 +01:00
`each()` function is deprecated, use `key()` and `current()` instead
2018-12-14 20:35:35 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php72\Rector\Assign\ListEachRector` ](../rules/Php72/Rector/Assign/ListEachRector.php )
2018-12-14 20:35:35 +01:00
```diff
2021-03-23 23:13:35 +01:00
-list($key, $callback) = each($callbacks);
+$key = key($callbacks);
+$callback = current($callbacks);
+next($callbacks);
2018-12-14 20:35:35 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-10-12 20:15:00 -03:00
2021-03-23 23:13:35 +01:00
### ParseStrWithResultArgumentRector
2020-07-29 01:41:20 +02:00
2021-03-23 23:13:35 +01:00
Use `$result` argument in `parse_str()` function
2018-10-12 20:15:00 -03:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php72\Rector\FuncCall\ParseStrWithResultArgumentRector` ](../rules/Php72/Rector/FuncCall/ParseStrWithResultArgumentRector.php )
2020-11-16 17:50:38 +00:00
2018-10-12 20:15:00 -03:00
```diff
2021-03-23 23:13:35 +01:00
-parse_str($this->query);
-$data = get_defined_vars();
+parse_str($this->query, $result);
+$data = $result;
2018-10-12 20:15:00 -03:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-11-11 13:22:35 +01:00
2021-03-23 23:13:35 +01:00
### ReplaceEachAssignmentWithKeyCurrentRector
2020-08-10 23:59:40 +02:00
2021-03-23 23:13:35 +01:00
Replace `each()` assign outside loop
2020-08-10 23:59:40 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php72\Rector\Assign\ReplaceEachAssignmentWithKeyCurrentRector` ](../rules/Php72/Rector/Assign/ReplaceEachAssignmentWithKeyCurrentRector.php )
2020-11-16 17:50:38 +00:00
2020-08-10 23:59:40 +02:00
```diff
2021-03-23 23:13:35 +01:00
$array = ['b' => 1, 'a' => 2];
2023-05-07 19:35:01 +00:00
2021-03-23 23:13:35 +01:00
-$eachedArray = each($array);
+$eachedArray[1] = current($array);
+$eachedArray['value'] = current($array);
+$eachedArray[0] = key($array);
+$eachedArray['key'] = key($array);
2023-05-07 19:35:01 +00:00
+
2021-03-23 23:13:35 +01:00
+next($array);
2020-08-10 23:59:40 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-08-10 23:59:40 +02:00
2021-03-23 23:13:35 +01:00
### StringifyDefineRector
2020-08-16 13:42:22 +02:00
2021-03-23 23:13:35 +01:00
Make first argument of `define()` string
2020-08-16 13:42:22 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php72\Rector\FuncCall\StringifyDefineRector` ](../rules/Php72/Rector/FuncCall/StringifyDefineRector.php )
2020-11-16 17:50:38 +00:00
2020-08-16 13:42:22 +02:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
2020-08-16 13:42:22 +02:00
{
2021-03-23 23:13:35 +01:00
public function run(int $a)
{
- define(CONSTANT_2, 'value');
+ define('CONSTANT_2', 'value');
define('CONSTANT', 'value');
}
2020-08-16 13:42:22 +02:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-08-08 00:21:17 +02:00
2021-03-23 23:13:35 +01:00
### StringsAssertNakedRector
2020-08-08 00:21:17 +02:00
2021-03-23 23:13:35 +01:00
String asserts must be passed directly to `assert()`
2020-08-08 00:21:17 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php72\Rector\FuncCall\StringsAssertNakedRector` ](../rules/Php72/Rector/FuncCall/StringsAssertNakedRector.php )
2020-11-16 17:50:38 +00:00
2020-08-08 00:21:17 +02:00
```diff
2021-03-23 23:13:35 +01:00
function nakedAssert()
2020-08-08 00:21:17 +02:00
{
2021-03-23 23:13:35 +01:00
- assert('true === true');
- assert("true === true");
+ assert(true === true);
+ assert(true === true);
2020-08-08 00:21:17 +02:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2019-11-07 00:52:19 +01:00
2021-03-23 23:13:35 +01:00
### UnsetCastRector
2019-11-07 00:52:19 +01:00
2021-03-23 23:13:35 +01:00
Removes (unset) cast
2019-11-07 00:52:19 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php72\Rector\Unset_\UnsetCastRector` ](../rules/Php72/Rector/Unset_/UnsetCastRector.php )
2020-11-16 17:50:38 +00:00
2019-11-07 00:52:19 +01:00
```diff
2021-03-23 23:13:35 +01:00
-$different = (unset) $value;
+$different = null;
2019-08-05 23:10:47 +02:00
2021-03-23 23:13:35 +01:00
-$value = (unset) $value;
+unset($value);
2019-08-05 23:10:47 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-08-08 00:21:17 +02:00
2021-03-23 23:13:35 +01:00
### WhileEachToForeachRector
2020-08-08 00:21:17 +02:00
2021-03-23 23:13:35 +01:00
`each()` function is deprecated, use `foreach()` instead.
2020-08-08 00:21:17 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php72\Rector\While_\WhileEachToForeachRector` ](../rules/Php72/Rector/While_/WhileEachToForeachRector.php )
2020-11-16 17:50:38 +00:00
2020-08-08 00:21:17 +02:00
```diff
2021-03-23 23:13:35 +01:00
-while (list($key, $callback) = each($callbacks)) {
+foreach ($callbacks as $key => $callback) {
// ...
2020-08-08 00:21:17 +02:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-05-10 00:05:46 +02:00
2020-05-31 17:26:08 +02:00
```diff
2021-03-23 23:13:35 +01:00
-while (list($key) = each($callbacks)) {
+foreach (array_keys($callbacks) as $key) {
// ...
2019-09-28 00:34:34 +02:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2019-09-28 00:34:34 +02:00
2021-03-23 23:13:35 +01:00
## Php73
2020-11-19 02:09:53 +01:00
2021-03-23 23:13:35 +01:00
### ArrayKeyFirstLastRector
2020-11-19 02:09:53 +01:00
2021-03-23 23:13:35 +01:00
Make use of `array_key_first()` and `array_key_last()`
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php73\Rector\FuncCall\ArrayKeyFirstLastRector` ](../rules/Php73/Rector/FuncCall/ArrayKeyFirstLastRector.php )
2020-11-19 02:09:53 +01:00
```diff
2021-03-23 23:13:35 +01:00
-reset($items);
-$firstKey = key($items);
+$firstKey = array_key_first($items);
2019-05-19 10:27:38 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-05-19 10:27:38 +02:00
2019-02-04 01:32:53 +01:00
```diff
2021-03-23 23:13:35 +01:00
-end($items);
-$lastKey = key($items);
+$lastKey = array_key_last($items);
2019-02-04 01:32:53 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-02-04 01:32:53 +01:00
2021-03-23 23:13:35 +01:00
### IsCountableRector
2019-09-28 00:34:34 +02:00
2021-04-10 20:18:49 +02:00
Changes is_array + Countable check to is_countable
2019-09-28 00:34:34 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php73\Rector\BooleanOr\IsCountableRector` ](../rules/Php73/Rector/BooleanOr/IsCountableRector.php )
2019-09-28 00:34:34 +02:00
```diff
2021-03-23 23:13:35 +01:00
-is_array($foo) || $foo instanceof Countable;
+is_countable($foo);
2019-09-28 00:34:34 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-02-21 15:36:16 +01:00
2021-03-23 23:13:35 +01:00
### JsonThrowOnErrorRector
2019-02-21 15:36:16 +01:00
2021-03-23 23:13:35 +01:00
Adds JSON_THROW_ON_ERROR to `json_encode()` and `json_decode()` to throw JsonException on error
2019-09-25 10:49:53 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php73\Rector\FuncCall\JsonThrowOnErrorRector` ](../rules/Php73/Rector/FuncCall/JsonThrowOnErrorRector.php )
2019-02-21 15:36:16 +01:00
2020-11-25 22:34:34 +01:00
```diff
2021-03-23 23:13:35 +01:00
-json_encode($content);
-json_decode($json);
+json_encode($content, JSON_THROW_ON_ERROR);
2021-04-18 15:01:56 +02:00
+json_decode($json, null, 512, JSON_THROW_ON_ERROR);
2020-11-25 22:34:34 +01:00
```
2019-05-02 01:56:58 +02:00
2020-11-25 22:34:34 +01:00
< br >
2019-05-02 01:56:58 +02:00
2021-03-23 23:13:35 +01:00
### RegexDashEscapeRector
2019-02-04 01:32:53 +01:00
2021-03-23 23:13:35 +01:00
Escape - in some cases
2019-02-04 01:32:53 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php73\Rector\FuncCall\RegexDashEscapeRector` ](../rules/Php73/Rector/FuncCall/RegexDashEscapeRector.php )
2019-02-04 01:32:53 +01:00
```diff
2021-03-23 23:13:35 +01:00
-preg_match("#[\w-()]#", 'some text');
+preg_match("#[\w\-()]#", 'some text');
2020-11-25 22:34:34 +01:00
```
2019-09-25 10:49:53 +02:00
2020-11-25 22:34:34 +01:00
< br >
2021-03-23 23:13:35 +01:00
### SensitiveConstantNameRector
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
Changes case insensitive constants to sensitive ones.
2020-11-25 22:34:34 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php73\Rector\ConstFetch\SensitiveConstantNameRector` ](../rules/Php73/Rector/ConstFetch/SensitiveConstantNameRector.php )
2020-11-25 22:34:34 +01:00
```diff
2021-03-23 23:13:35 +01:00
define('FOO', 42, true);
var_dump(FOO);
-var_dump(foo);
+var_dump(FOO);
2019-02-04 01:32:53 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-02-04 01:32:53 +01:00
2021-03-23 23:13:35 +01:00
### SensitiveDefineRector
2019-02-04 01:32:53 +01:00
2021-03-23 23:13:35 +01:00
Changes case insensitive constants to sensitive ones.
2019-09-25 10:49:53 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php73\Rector\FuncCall\SensitiveDefineRector` ](../rules/Php73/Rector/FuncCall/SensitiveDefineRector.php )
2019-02-04 01:32:53 +01:00
```diff
2021-03-23 23:13:35 +01:00
-define('FOO', 42, true);
+define('FOO', 42);
2019-02-04 01:32:53 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-02-04 01:32:53 +01:00
2021-03-23 23:13:35 +01:00
### SensitiveHereNowDocRector
2019-02-21 15:36:16 +01:00
2021-03-23 23:13:35 +01:00
Changes heredoc/nowdoc that contains closing word to safe wrapper name
2020-07-29 01:41:20 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php73\Rector\String_\SensitiveHereNowDocRector` ](../rules/Php73/Rector/String_/SensitiveHereNowDocRector.php )
2019-02-21 15:36:16 +01:00
```diff
2021-03-23 23:13:35 +01:00
-$value = < < < A
+$value = < < < A_WRAP
A
-A
+A_WRAP
2019-02-04 01:32:53 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-02-04 01:32:53 +01:00
2021-03-23 23:13:35 +01:00
### SetCookieRector
2019-05-29 15:40:20 +02:00
2021-04-10 20:18:49 +02:00
Convert setcookie argument to PHP7.3 option array
2019-05-29 15:40:20 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php73\Rector\FuncCall\SetCookieRector` ](../rules/Php73/Rector/FuncCall/SetCookieRector.php )
2019-02-04 01:32:53 +01:00
```diff
2021-03-23 23:13:35 +01:00
-setcookie('name', $value, 360);
+setcookie('name', $value, ['expires' => 360]);
2019-02-04 01:32:53 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-02-04 01:32:53 +01:00
2021-03-23 23:13:35 +01:00
```diff
-setcookie('name', $name, 0, '', '', true, true);
+setcookie('name', $name, ['expires' => 0, 'path' => '', 'domain' => '', 'secure' => true, 'httponly' => true]);
```
2019-02-04 01:32:53 +01:00
2021-03-23 23:13:35 +01:00
< br >
2019-02-04 01:32:53 +01:00
2021-03-23 23:13:35 +01:00
### StringifyStrNeedlesRector
Makes needles explicit strings
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php73\Rector\FuncCall\StringifyStrNeedlesRector` ](../rules/Php73/Rector/FuncCall/StringifyStrNeedlesRector.php )
2019-02-04 01:32:53 +01:00
```diff
2021-03-23 23:13:35 +01:00
$needle = 5;
-$fivePosition = strpos('725', $needle);
+$fivePosition = strpos('725', (string) $needle);
2019-02-04 01:32:53 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-09-24 20:54:39 +02:00
2021-03-23 23:13:35 +01:00
## Php74
2020-09-24 20:54:39 +02:00
2021-03-23 23:13:35 +01:00
### AddLiteralSeparatorToNumberRector
2020-07-29 01:41:20 +02:00
2021-03-23 23:13:35 +01:00
Add "_" as thousands separator in numbers for higher or equals to limitValue config
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php74\Rector\LNumber\AddLiteralSeparatorToNumberRector` ](../rules/Php74/Rector/LNumber/AddLiteralSeparatorToNumberRector.php )
2021-03-23 23:13:35 +01:00
2019-03-09 13:24:30 +00:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2020-07-29 01:41:20 +02:00
{
2020-11-25 22:34:34 +01:00
public function run()
2020-07-29 01:41:20 +02:00
{
2021-03-23 23:13:35 +01:00
- $int = 500000;
- $float = 1000500.001;
+ $int = 500_000;
+ $float = 1_000_500.001;
2020-11-25 22:34:34 +01:00
}
}
```
< br >
2021-03-23 23:13:35 +01:00
### ArrayKeyExistsOnPropertyRector
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
Change `array_key_exists()` on property to `property_exists()`
2020-11-25 22:34:34 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php74\Rector\FuncCall\ArrayKeyExistsOnPropertyRector` ](../rules/Php74/Rector/FuncCall/ArrayKeyExistsOnPropertyRector.php )
2020-11-25 22:34:34 +01:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
public $value;
2020-07-29 01:41:20 +02:00
}
2021-03-23 23:13:35 +01:00
$someClass = new SomeClass;
-array_key_exists('value', $someClass);
+property_exists($someClass, 'value');
2019-03-09 13:24:30 +00:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-03-09 13:24:30 +00:00
2021-03-23 23:13:35 +01:00
### ClosureToArrowFunctionRector
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
Change closure to arrow function
2020-11-25 22:34:34 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php74\Rector\Closure\ClosureToArrowFunctionRector` ](../rules/Php74/Rector/Closure/ClosureToArrowFunctionRector.php )
2020-08-30 14:45:03 +02:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
2020-11-16 17:50:38 +00:00
{
2021-03-23 23:13:35 +01:00
public function run($meetups)
2020-11-16 17:50:38 +00:00
{
2021-03-23 23:13:35 +01:00
- return array_filter($meetups, function (Meetup $meetup) {
- return is_object($meetup);
- });
+ return array_filter($meetups, fn(Meetup $meetup) => is_object($meetup));
2020-11-16 17:50:38 +00:00
}
}
2020-08-30 14:45:03 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-08-30 14:45:03 +02:00
2021-09-12 00:30:25 +00:00
### CurlyToSquareBracketArrayStringRector
Change curly based array and string to square bracket
- class: [`Rector\Php74\Rector\ArrayDimFetch\CurlyToSquareBracketArrayStringRector` ](../rules/Php74/Rector/ArrayDimFetch/CurlyToSquareBracketArrayStringRector.php )
```diff
$string = 'test';
-echo $string{0};
+echo $string[0];
2023-05-24 15:09:06 +00:00
2021-09-12 00:30:25 +00:00
$array = ['test'];
-echo $array{0};
+echo $array[0];
```
< br >
2021-03-23 23:13:35 +01:00
### ExportToReflectionFunctionRector
2019-02-21 15:36:16 +01:00
2021-03-23 23:13:35 +01:00
Change `export()` to ReflectionFunction alternatives
2019-06-02 10:45:37 +03:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php74\Rector\StaticCall\ExportToReflectionFunctionRector` ](../rules/Php74/Rector/StaticCall/ExportToReflectionFunctionRector.php )
2019-06-02 10:45:37 +03:00
2020-11-16 01:40:38 +01:00
```diff
2021-03-23 23:13:35 +01:00
-$reflectionFunction = ReflectionFunction::export('foo');
-$reflectionFunctionAsString = ReflectionFunction::export('foo', true);
+$reflectionFunction = new ReflectionFunction('foo');
+$reflectionFunctionAsString = (string) new ReflectionFunction('foo');
2020-11-16 01:40:38 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-11-16 01:40:38 +01:00
2021-03-23 23:13:35 +01:00
### FilterVarToAddSlashesRector
2019-06-02 10:45:37 +03:00
2021-03-23 23:13:35 +01:00
Change `filter_var()` with slash escaping to `addslashes()`
2020-11-16 17:50:38 +00:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php74\Rector\FuncCall\FilterVarToAddSlashesRector` ](../rules/Php74/Rector/FuncCall/FilterVarToAddSlashesRector.php )
2020-11-16 17:50:38 +00:00
2020-11-25 22:34:34 +01:00
```diff
2021-03-23 23:13:35 +01:00
$var= "Satya's here!";
-filter_var($var, FILTER_SANITIZE_MAGIC_QUOTES);
+addslashes($var);
2019-02-21 15:36:16 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-02-21 15:36:16 +01:00
2021-03-23 23:13:35 +01:00
### MbStrrposEncodingArgumentPositionRector
2020-11-14 02:27:55 +01:00
2021-03-23 23:13:35 +01:00
Change `mb_strrpos()` encoding argument position
2020-11-14 02:27:55 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php74\Rector\FuncCall\MbStrrposEncodingArgumentPositionRector` ](../rules/Php74/Rector/FuncCall/MbStrrposEncodingArgumentPositionRector.php )
2020-11-25 22:34:34 +01:00
```diff
2021-03-23 23:13:35 +01:00
-mb_strrpos($text, "abc", "UTF-8");
+mb_strrpos($text, "abc", 0, "UTF-8");
2020-11-14 02:27:55 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-11-14 02:27:55 +01:00
2022-08-28 00:39:05 +00:00
### MoneyFormatToNumberFormatRector
Change `money_format()` to equivalent `number_format()`
- class: [`Rector\Php74\Rector\FuncCall\MoneyFormatToNumberFormatRector` ](../rules/Php74/Rector/FuncCall/MoneyFormatToNumberFormatRector.php )
```diff
-$value = money_format('%i', $value);
2023-08-05 10:29:33 +00:00
+$value = number_format(round($value, 2, PHP_ROUND_HALF_ODD), 2, '.', '');
2022-08-28 00:39:05 +00:00
```
< br >
2021-03-23 23:13:35 +01:00
### NullCoalescingOperatorRector
2019-05-29 15:40:20 +02:00
2021-03-23 23:13:35 +01:00
Use null coalescing operator ??=
2020-07-21 10:23:25 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php74\Rector\Assign\NullCoalescingOperatorRector` ](../rules/Php74/Rector/Assign/NullCoalescingOperatorRector.php )
2020-07-21 10:23:25 +01:00
2020-11-25 22:34:34 +01:00
```diff
2021-03-23 23:13:35 +01:00
$array = [];
-$array['user_id'] = $array['user_id'] ?? 'value';
+$array['user_id'] ??= 'value';
2020-11-25 22:34:34 +01:00
```
< br >
2019-05-29 15:40:20 +02:00
2022-08-31 07:08:44 +00:00
### ParenthesizeNestedTernaryRector
Add parentheses to nested ternary
- class: [`Rector\Php74\Rector\Ternary\ParenthesizeNestedTernaryRector` ](../rules/Php74/Rector/Ternary/ParenthesizeNestedTernaryRector.php )
```diff
-$value = $a ? $b : $a ?: null;
+$value = ($a ? $b : $a) ?: null;
```
< br >
2021-03-23 23:13:35 +01:00
### RealToFloatTypeCastRector
2019-05-29 15:40:20 +02:00
2021-03-23 23:13:35 +01:00
Change deprecated (real) to (float)
2020-11-25 22:34:34 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php74\Rector\Double\RealToFloatTypeCastRector` ](../rules/Php74/Rector/Double/RealToFloatTypeCastRector.php )
2019-09-25 10:49:53 +02:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
{
public function run()
{
- $number = (real) 5;
+ $number = (float) 5;
$number = (float) 5;
$number = (double) 5;
}
}
2020-11-25 22:34:34 +01:00
```
< br >
2021-03-23 23:13:35 +01:00
### RestoreDefaultNullToNullableTypePropertyRector
2020-11-19 02:09:53 +01:00
2021-03-23 23:13:35 +01:00
Add null default to properties with PHP 7.4 property nullable type
2020-11-19 02:09:53 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php74\Rector\Property\RestoreDefaultNullToNullableTypePropertyRector` ](../rules/Php74/Rector/Property/RestoreDefaultNullToNullableTypePropertyRector.php )
2020-11-19 02:09:53 +01:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
{
- public ?string $name;
+ public ?string $name = null;
}
2020-11-19 02:09:53 +01:00
```
< br >
2021-03-23 23:13:35 +01:00
## Php80
2018-07-31 14:50:39 +02:00
2021-12-10 07:56:16 +00:00
### AddParamBasedOnParentClassMethodRector
Add missing parameter based on parent class method
- class: [`Rector\Php80\Rector\ClassMethod\AddParamBasedOnParentClassMethodRector` ](../rules/Php80/Rector/ClassMethod/AddParamBasedOnParentClassMethodRector.php )
```diff
class A
{
public function execute($foo)
{
}
}
class B extends A{
- public function execute()
+ public function execute($foo)
{
}
}
```
< br >
2021-03-23 23:13:35 +01:00
### AnnotationToAttributeRector
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
Change annotation to attribute
2020-11-16 17:50:38 +00:00
2021-03-23 23:13:35 +01:00
:wrench: **configure it!**
2020-11-16 17:50:38 +00:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php80\Rector\Class_\AnnotationToAttributeRector` ](../rules/Php80/Rector/Class_/AnnotationToAttributeRector.php )
2018-12-22 12:22:28 +01:00
2018-07-31 14:50:39 +02:00
```diff
2021-03-23 23:13:35 +01:00
use Symfony\Component\Routing\Annotation\Route;
2020-07-29 01:41:20 +02:00
2021-03-23 23:13:35 +01:00
class SymfonyRoute
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
- /**
- * @Route ("/path", name="action")
- */
+ #[Route(path: '/path', name: 'action')]
public function action()
2020-07-29 01:41:20 +02:00
{
}
}
2018-08-01 22:09:34 +02:00
```
2018-08-01 15:34:55 +02:00
2020-11-16 17:50:38 +00:00
< br >
2018-10-12 20:15:00 -03:00
2021-03-23 23:13:35 +01:00
### ChangeSwitchToMatchRector
2019-09-25 10:49:53 +02:00
2021-03-23 23:13:35 +01:00
Change `switch()` to `match()`
2019-03-09 13:24:30 +00:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php80\Rector\Switch_\ChangeSwitchToMatchRector` ](../rules/Php80/Rector/Switch_/ChangeSwitchToMatchRector.php )
2020-07-29 01:41:20 +02:00
2020-11-25 22:34:34 +01:00
```diff
2021-06-13 10:00:46 +00:00
-switch ($input) {
- case Lexer::T_SELECT:
- $statement = 'select';
- break;
- case Lexer::T_UPDATE:
- $statement = 'update';
- break;
- default:
- $statement = 'error';
-}
+$statement = match ($input) {
+ Lexer::T_SELECT => 'select',
+ Lexer::T_UPDATE => 'update',
+ default => 'error',
+};
2018-12-31 12:50:32 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-12-31 12:50:32 +01:00
2021-03-23 23:13:35 +01:00
### ClassOnObjectRector
2018-10-12 20:15:00 -03:00
2021-03-23 23:13:35 +01:00
Change get_class($object) to faster `$object::class`
2018-11-11 13:22:35 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php80\Rector\FuncCall\ClassOnObjectRector` ](../rules/Php80/Rector/FuncCall/ClassOnObjectRector.php )
2018-10-12 20:15:00 -03:00
2018-08-01 22:09:34 +02:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
2020-08-30 14:45:03 +02:00
{
2021-03-23 23:13:35 +01:00
public function run($object)
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
- return get_class($object);
+ return $object::class;
2020-11-25 22:34:34 +01:00
}
2020-08-30 14:45:03 +02:00
}
2018-05-05 13:48:33 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-11-11 13:22:35 +01:00
2022-11-26 10:04:16 +00:00
### ClassOnThisVariableObjectRector
Change `$this::class` to static::class or self::class depends on class modifier
- class: [`Rector\Php80\Rector\ClassConstFetch\ClassOnThisVariableObjectRector` ](../rules/Php80/Rector/ClassConstFetch/ClassOnThisVariableObjectRector.php )
```diff
class SomeClass
{
public function run()
{
- return $this::class;
+ return static::class;
}
}
```
< br >
2021-03-23 23:13:35 +01:00
### ClassPropertyAssignToConstructorPromotionRector
2019-05-02 01:56:58 +02:00
2021-03-23 23:13:35 +01:00
Change simple property init and assign to constructor promotion
2019-05-02 01:56:58 +02:00
2022-11-29 15:48:49 +00:00
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php80\Rector\Class_\ClassPropertyAssignToConstructorPromotionRector` ](../rules/Php80/Rector/Class_/ClassPropertyAssignToConstructorPromotionRector.php )
2019-05-02 01:56:58 +02:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
2020-11-25 22:34:34 +01:00
{
2023-12-26 17:40:03 +00:00
- public float $price;
2021-03-23 23:13:35 +01:00
-
2021-11-25 19:16:58 +00:00
public function __construct(
2023-12-26 17:40:03 +00:00
- float $price = 0.0
+ public float $price = 0.0
2021-11-25 19:16:58 +00:00
) {
2023-12-26 17:40:03 +00:00
- $this->price = $price;
2020-11-25 22:34:34 +01:00
}
}
2019-05-02 01:56:58 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-05-02 01:56:58 +02:00
2021-03-23 23:13:35 +01:00
### FinalPrivateToPrivateVisibilityRector
2019-02-04 01:32:53 +01:00
2021-03-23 23:13:35 +01:00
Changes method visibility from final private to only private
2019-02-04 01:32:53 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php80\Rector\ClassMethod\FinalPrivateToPrivateVisibilityRector` ](../rules/Php80/Rector/ClassMethod/FinalPrivateToPrivateVisibilityRector.php )
2019-02-04 01:32:53 +01:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
{
- final private function getter() {
+ private function getter() {
return $this;
}
}
2019-02-04 01:32:53 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-02-04 01:32:53 +01:00
2021-03-23 23:13:35 +01:00
### GetDebugTypeRector
2020-06-17 14:12:29 +02:00
2021-03-23 23:13:35 +01:00
Change ternary type resolve to `get_debug_type()`
2020-06-17 14:12:29 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php80\Rector\Ternary\GetDebugTypeRector` ](../rules/Php80/Rector/Ternary/GetDebugTypeRector.php )
2020-06-17 14:12:29 +02:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
2020-07-29 01:41:20 +02:00
{
2021-03-23 23:13:35 +01:00
public function run($value)
{
- return is_object($value) ? get_class($value) : gettype($value);
+ return get_debug_type($value);
}
2020-07-29 01:41:20 +02:00
}
2020-06-17 14:12:29 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-06-17 14:12:29 +02:00
2022-07-31 00:37:06 +00:00
### MixedTypeRector
Change mixed docs type to mixed typed
- class: [`Rector\Php80\Rector\FunctionLike\MixedTypeRector` ](../rules/Php80/Rector/FunctionLike/MixedTypeRector.php )
```diff
class SomeClass
{
- /**
- * @param mixed $param
- */
- public function run($param)
+ public function run(mixed $param)
{
}
}
```
< br >
2022-08-21 00:33:55 +00:00
### NestedAnnotationToAttributeRector
Changed nested annotations to attributes
:wrench: **configure it!**
- class: [`Rector\Php80\Rector\Property\NestedAnnotationToAttributeRector` ](../rules/Php80/Rector/Property/NestedAnnotationToAttributeRector.php )
```diff
use Doctrine\ORM\Mapping as ORM;
class SomeEntity
{
- /**
- * @ORM \JoinTable(name="join_table_name",
- * joinColumns={@ORM \JoinColumn(name="origin_id")},
- * inverseJoinColumns={@ORM \JoinColumn(name="target_id")}
- * )
- */
+ #[ORM\JoinTable(name: 'join_table_name')]
+ #[ORM\JoinColumn(name: 'origin_id')]
+ #[ORM\InverseJoinColumn(name: 'target_id')]
private $collection;
}
```
< br >
2021-03-23 23:13:35 +01:00
### RemoveUnusedVariableInCatchRector
2019-02-04 01:32:53 +01:00
2021-03-23 23:13:35 +01:00
Remove unused variable in `catch()`
2019-02-04 01:32:53 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php80\Rector\Catch_\RemoveUnusedVariableInCatchRector` ](../rules/Php80/Rector/Catch_/RemoveUnusedVariableInCatchRector.php )
2019-02-04 01:32:53 +01:00
2020-11-25 22:34:34 +01:00
```diff
2021-03-23 23:13:35 +01:00
final class SomeClass
{
public function run()
{
try {
- } catch (Throwable $notUsedThrowable) {
+ } catch (Throwable) {
}
}
}
2020-11-25 22:34:34 +01:00
```
2019-02-04 01:32:53 +01:00
2020-11-25 22:34:34 +01:00
< br >
2019-02-04 01:32:53 +01:00
2021-03-23 23:13:35 +01:00
### SetStateToStaticRector
2021-03-18 00:11:23 +01:00
2021-03-23 23:13:35 +01:00
Adds static visibility to `__set_state()` methods
2021-03-18 00:11:23 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php80\Rector\ClassMethod\SetStateToStaticRector` ](../rules/Php80/Rector/ClassMethod/SetStateToStaticRector.php )
2021-03-18 00:11:23 +01:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
{
- public function __set_state($properties) {
+ public static function __set_state($properties) {
}
}
2021-03-18 00:11:23 +01:00
```
< br >
2021-03-23 23:13:35 +01:00
### StrContainsRector
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
Replace `strpos()` !== false and `strstr()` with `str_contains()`
2020-11-25 22:34:34 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php80\Rector\NotIdentical\StrContainsRector` ](../rules/Php80/Rector/NotIdentical/StrContainsRector.php )
2019-02-04 01:32:53 +01:00
2018-07-31 21:43:39 +02:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
public function run()
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
- return strpos('abc', 'a') !== false;
+ return str_contains('abc', 'a');
2020-11-25 22:34:34 +01:00
}
2019-06-02 10:45:37 +03:00
}
2018-07-31 21:43:39 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-11-11 13:22:35 +01:00
2021-03-23 23:13:35 +01:00
### StrEndsWithRector
2018-08-01 22:09:34 +02:00
2021-03-23 23:13:35 +01:00
Change helper functions to `str_ends_with()`
2019-09-25 10:49:53 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php80\Rector\Identical\StrEndsWithRector` ](../rules/Php80/Rector/Identical/StrEndsWithRector.php )
2018-08-01 22:09:34 +02:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
public function run()
{
- $isMatch = substr($haystack, -strlen($needle)) === $needle;
+ $isMatch = str_ends_with($haystack, $needle);
2021-07-22 18:40:24 +00:00
- $isNotMatch = substr($haystack, -strlen($needle)) !== $needle;
+ $isNotMatch = !str_ends_with($haystack, $needle);
}
}
```
< br >
```diff
class SomeClass
{
public function run()
{
- $isMatch = substr($haystack, -9) === 'hardcoded;
+ $isMatch = str_ends_with($haystack, 'hardcoded');
- $isNotMatch = substr($haystack, -9) !== 'hardcoded';
+ $isNotMatch = !str_ends_with($haystack, 'hardcoded');
2021-03-23 23:13:35 +01:00
}
2020-11-25 22:34:34 +01:00
}
2020-11-16 17:50:38 +00:00
```
2019-09-25 10:49:53 +02:00
2020-11-16 17:50:38 +00:00
< br >
2021-03-23 23:13:35 +01:00
### StrStartsWithRector
2020-11-16 17:50:38 +00:00
2021-03-23 23:13:35 +01:00
Change helper functions to `str_starts_with()`
2020-11-16 17:50:38 +00:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php80\Rector\Identical\StrStartsWithRector` ](../rules/Php80/Rector/Identical/StrStartsWithRector.php )
2020-11-16 17:50:38 +00:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
2020-07-29 01:41:20 +02:00
{
2021-03-23 23:13:35 +01:00
public function run()
2020-07-29 01:41:20 +02:00
{
2021-03-23 23:13:35 +01:00
- $isMatch = substr($haystack, 0, strlen($needle)) === $needle;
+ $isMatch = str_starts_with($haystack, $needle);
- $isNotMatch = substr($haystack, 0, strlen($needle)) !== $needle;
+ $isNotMatch = ! str_starts_with($haystack, $needle);
2020-07-29 01:41:20 +02:00
}
}
2018-08-01 22:09:34 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-11-11 13:22:35 +01:00
2021-03-23 23:13:35 +01:00
### StringableForToStringRector
2019-05-02 01:56:58 +02:00
2021-03-23 23:13:35 +01:00
Add `Stringable` interface to classes with `__toString()` method
2020-07-29 01:41:20 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php80\Rector\Class_\StringableForToStringRector` ](../rules/Php80/Rector/Class_/StringableForToStringRector.php )
2019-05-02 01:56:58 +02:00
```diff
2021-03-23 23:13:35 +01:00
-class SomeClass
+class SomeClass implements Stringable
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
- public function __toString()
+ public function __toString(): string
2020-07-29 01:41:20 +02:00
{
2021-03-23 23:13:35 +01:00
return 'I can stringz';
2020-11-16 17:50:38 +00:00
}
2020-11-25 22:34:34 +01:00
}
```
2020-11-16 17:50:38 +00:00
2020-11-25 22:34:34 +01:00
< br >
2021-05-16 08:19:51 +00:00
## Php81
2021-07-23 16:35:16 +00:00
### FinalizePublicClassConstantRector
2022-01-30 00:27:52 +00:00
Add final to constants that does not have children
2021-07-23 16:35:16 +00:00
- class: [`Rector\Php81\Rector\ClassConst\FinalizePublicClassConstantRector` ](../rules/Php81/Rector/ClassConst/FinalizePublicClassConstantRector.php )
```diff
class SomeClass
{
- public const NAME = 'value';
2022-05-18 10:48:11 +00:00
+ final public const NAME = 'value';
2021-07-23 16:35:16 +00:00
}
```
< br >
2022-06-21 07:39:15 +00:00
### FirstClassCallableRector
Upgrade array callable to first class callable
- class: [`Rector\Php81\Rector\Array_\FirstClassCallableRector` ](../rules/Php81/Rector/Array_/FirstClassCallableRector.php )
```diff
final class SomeClass
{
public function run()
{
- $name = [$this, 'name'];
+ $name = $this->name(...);
}
public function name()
{
}
}
```
< br >
2021-05-16 08:19:51 +00:00
### MyCLabsClassToEnumRector
Refactor MyCLabs enum class to native Enum
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php81\Rector\Class_\MyCLabsClassToEnumRector` ](../rules/Php81/Rector/Class_/MyCLabsClassToEnumRector.php )
2021-05-16 08:19:51 +00:00
```diff
-use MyCLabs\Enum\Enum;
-
-final class Action extends Enum
2021-12-05 00:35:40 +00:00
+enum Action : string
2021-05-16 08:19:51 +00:00
{
- private const VIEW = 'view';
- private const EDIT = 'edit';
+ case VIEW = 'view';
+ case EDIT = 'edit';
}
```
< br >
### MyCLabsMethodCallToEnumConstRector
Refactor MyCLabs enum fetch to Enum const
2021-05-23 09:33:26 +00:00
- class: [`Rector\Php81\Rector\MethodCall\MyCLabsMethodCallToEnumConstRector` ](../rules/Php81/Rector/MethodCall/MyCLabsMethodCallToEnumConstRector.php )
2021-05-16 08:19:51 +00:00
```diff
-$name = SomeEnum::VALUE()->getKey();
+$name = SomeEnum::VALUE;
```
< br >
2021-11-14 00:36:15 +00:00
### NewInInitializerRector
Replace property declaration of new state with direct new
- class: [`Rector\Php81\Rector\ClassMethod\NewInInitializerRector` ](../rules/Php81/Rector/ClassMethod/NewInInitializerRector.php )
```diff
class SomeClass
{
2021-11-25 12:53:25 +00:00
- private Logger $logger;
-
2021-11-14 00:36:15 +00:00
public function __construct(
- ?Logger $logger = null,
2021-11-25 12:53:25 +00:00
+ private Logger $logger = new NullLogger,
2021-11-14 00:36:15 +00:00
) {
- $this->logger = $logger ?? new NullLogger;
}
}
```
< br >
2022-01-16 01:52:41 +00:00
### NullToStrictStringFuncCallArgRector
Change null to strict string defined function call args
- class: [`Rector\Php81\Rector\FuncCall\NullToStrictStringFuncCallArgRector` ](../rules/Php81/Rector/FuncCall/NullToStrictStringFuncCallArgRector.php )
```diff
class SomeClass
{
public function run()
{
- preg_split("#a #", null);
+ preg_split("#a #", '');
}
}
```
< br >
2021-07-23 16:35:16 +00:00
### ReadOnlyPropertyRector
Decorate read-only property with `readonly` attribute
- class: [`Rector\Php81\Rector\Property\ReadOnlyPropertyRector` ](../rules/Php81/Rector/Property/ReadOnlyPropertyRector.php )
```diff
class SomeClass
{
public function __construct(
- private string $name
+ private readonly string $name
) {
}
public function getName()
{
return $this->name;
}
}
```
< br >
2021-08-15 00:30:09 +00:00
### SpatieEnumClassToEnumRector
Refactor Spatie enum class to native Enum
2024-01-16 10:21:57 +00:00
:wrench: **configure it!**
2021-08-15 00:30:09 +00:00
- class: [`Rector\Php81\Rector\Class_\SpatieEnumClassToEnumRector` ](../rules/Php81/Rector/Class_/SpatieEnumClassToEnumRector.php )
```diff
-use \Spatie\Enum\Enum;
-
-/**
- * @method static self draft()
- * @method static self published()
- * @method static self archived()
- */
-class StatusEnum extends Enum
2021-12-05 00:35:40 +00:00
+enum StatusEnum : string
2021-08-15 00:30:09 +00:00
{
2022-06-13 09:09:58 +00:00
+ case DRAFT = 'draft';
+ case PUBLISHED = 'published';
+ case ARCHIVED = 'archived';
2021-08-15 00:30:09 +00:00
}
```
< br >
2022-12-28 12:01:35 +00:00
### SpatieEnumMethodCallToEnumConstRector
Refactor Spatie enum method calls
- class: [`Rector\Php81\Rector\MethodCall\SpatieEnumMethodCallToEnumConstRector` ](../rules/Php81/Rector/MethodCall/SpatieEnumMethodCallToEnumConstRector.php )
```diff
-$value1 = SomeEnum::SOME_CONSTANT()->getValue();
-$value2 = SomeEnum::SOME_CONSTANT()->value;
-$name1 = SomeEnum::SOME_CONSTANT()->getName();
-$name2 = SomeEnum::SOME_CONSTANT()->name;
+$value1 = SomeEnum::SOME_CONSTANT->value;
+$value2 = SomeEnum::SOME_CONSTANT->value;
+$name1 = SomeEnum::SOME_CONSTANT->name;
+$name2 = SomeEnum::SOME_CONSTANT->name;
```
< br >
2022-05-15 09:42:33 +00:00
## Php82
2023-06-26 18:55:49 +00:00
### AddSensitiveParameterAttributeRector
Add SensitiveParameter attribute to method and function configured parameters
:wrench: **configure it!**
- class: [`Rector\Php82\Rector\Param\AddSensitiveParameterAttributeRector` ](../rules/Php82/Rector/Param/AddSensitiveParameterAttributeRector.php )
```diff
class SomeClass
{
- public function run(string $password)
+ public function run(#[\SensitiveParameter] string $password)
{
}
}
```
< br >
2023-01-18 12:08:19 +00:00
### FilesystemIteratorSkipDotsRector
Prior PHP 8.2 FilesystemIterator::SKIP_DOTS was always set and could not be removed, therefore FilesystemIterator::SKIP_DOTS is added in order to keep this behaviour.
- class: [`Rector\Php82\Rector\New_\FilesystemIteratorSkipDotsRector` ](../rules/Php82/Rector/New_/FilesystemIteratorSkipDotsRector.php )
```diff
2023-01-22 00:34:51 +00:00
-new FilesystemIterator(__DIR__, FilesystemIterator::KEY_AS_FILENAME);
+new FilesystemIterator(__DIR__, FilesystemIterator::KEY_AS_FILENAME | FilesystemIterator::SKIP_DOTS);
2023-01-18 12:08:19 +00:00
```
< br >
2022-05-15 09:42:33 +00:00
### ReadOnlyClassRector
Decorate read-only class with `readonly` attribute
- class: [`Rector\Php82\Rector\Class_\ReadOnlyClassRector` ](../rules/Php82/Rector/Class_/ReadOnlyClassRector.php )
```diff
-final class SomeClass
+final readonly class SomeClass
{
public function __construct(
- private readonly string $name
+ private string $name
) {
}
}
```
< br >
2022-12-17 08:33:16 +00:00
### Utf8DecodeEncodeToMbConvertEncodingRector
Change deprecated utf8_decode and utf8_encode to mb_convert_encoding
- class: [`Rector\Php82\Rector\FuncCall\Utf8DecodeEncodeToMbConvertEncodingRector` ](../rules/Php82/Rector/FuncCall/Utf8DecodeEncodeToMbConvertEncodingRector.php )
```diff
-utf8_decode($value);
-utf8_encode($value);
+mb_convert_encoding($value, 'ISO-8859-1');
+mb_convert_encoding($value, 'UTF-8', 'ISO-8859-1');
```
< br >
2023-11-03 12:13:20 +00:00
## Php83
### AddOverrideAttributeToOverriddenMethodsRector
Add override attribute to overridden methods
- class: [`Rector\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector` ](../rules/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector.php )
```diff
class ParentClass
{
public function foo()
{
}
}
class ChildClass extends ParentClass
{
+ #[\Override]
public function foo()
{
}
}
```
< br >
2023-12-03 14:59:47 +00:00
### AddTypeToConstRector
Add const to type
- class: [`Rector\Php83\Rector\ClassConst\AddTypeToConstRector` ](../rules/Php83/Rector/ClassConst/AddTypeToConstRector.php )
```diff
final class SomeClass
{
- public const TYPE = 'some_type';
+ public const string TYPE = 'some_type';
}
```
< br >
2023-12-30 11:58:36 +00:00
### CombineHostPortLdapUriRector
Combine separated host and port on `ldap_connect()` args
- class: [`Rector\Php83\Rector\FuncCall\CombineHostPortLdapUriRector` ](../rules/Php83/Rector/FuncCall/CombineHostPortLdapUriRector.php )
```diff
-ldap_connect('ldap://ldap.example.com', 389);
+ldap_connect('ldap://ldap.example.com:389');
```
< br >
2021-03-23 23:13:35 +01:00
## Privatization
2020-06-05 12:33:30 +02:00
2024-01-02 21:38:33 +00:00
### FinalizeClassesWithoutChildrenRector
Finalize every class that has no children
- class: [`Rector\Privatization\Rector\Class_\FinalizeClassesWithoutChildrenRector` ](../rules/Privatization/Rector/Class_/FinalizeClassesWithoutChildrenRector.php )
```diff
-class FirstClass extends SecondClass
+final class FirstClass extends SecondClass
{
}
2020-07-29 01:41:20 +02:00
2024-01-02 21:38:33 +00:00
class SecondClass
2021-03-23 23:13:35 +01:00
{
2020-11-25 22:34:34 +01:00
}
2020-11-16 17:50:38 +00:00
```
2019-07-06 21:51:36 +02:00
2020-11-16 17:50:38 +00:00
< br >
2020-09-24 20:54:39 +02:00
2021-03-23 23:13:35 +01:00
### PrivatizeFinalClassMethodRector
2021-03-13 00:52:38 +01:00
2021-03-23 23:13:35 +01:00
Change protected class method to private if possible
2020-10-21 23:06:24 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Privatization\Rector\ClassMethod\PrivatizeFinalClassMethodRector` ](../rules/Privatization/Rector/ClassMethod/PrivatizeFinalClassMethodRector.php )
2020-10-21 23:06:24 +02:00
2020-11-16 17:50:38 +00:00
```diff
2020-11-25 22:34:34 +01:00
final class SomeClass
2020-11-16 17:50:38 +00:00
{
2021-03-23 23:13:35 +01:00
- protected function someMethod()
+ private function someMethod()
2020-11-16 17:50:38 +00:00
{
}
}
```
2020-10-21 23:06:24 +02:00
2020-11-16 17:50:38 +00:00
< br >
2020-10-21 23:06:24 +02:00
2021-03-23 23:13:35 +01:00
### PrivatizeFinalClassPropertyRector
2021-03-13 00:52:38 +01:00
2021-03-23 23:13:35 +01:00
Change property to private if possible
2020-07-22 23:31:42 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Privatization\Rector\Property\PrivatizeFinalClassPropertyRector` ](../rules/Privatization/Rector/Property/PrivatizeFinalClassPropertyRector.php )
2020-07-22 23:31:42 +02:00
```diff
2021-03-23 23:13:35 +01:00
final class SomeClass
{
- protected $value;
+ private $value;
}
2020-11-16 17:50:38 +00:00
```
2020-07-22 23:31:42 +02:00
2020-11-16 17:50:38 +00:00
< br >
2021-03-23 23:13:35 +01:00
### PrivatizeLocalGetterToPropertyRector
2018-09-29 00:33:35 +08:00
2021-03-23 23:13:35 +01:00
Privatize getter of local property to property
2020-11-25 22:34:34 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Privatization\Rector\MethodCall\PrivatizeLocalGetterToPropertyRector` ](../rules/Privatization/Rector/MethodCall/PrivatizeLocalGetterToPropertyRector.php )
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
```diff
class SomeClass
{
private $some;
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
public function run()
{
- return $this->getSome() + 5;
+ return $this->some + 5;
}
2018-09-29 00:33:35 +08:00
2021-03-23 23:13:35 +01:00
private function getSome()
{
return $this->some;
}
}
2018-09-29 00:33:35 +08:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-11-11 13:22:35 +01:00
2021-03-23 23:13:35 +01:00
## Removing
2020-11-16 17:50:38 +00:00
2021-03-23 23:13:35 +01:00
### ArgumentRemoverRector
2021-01-28 19:26:56 +01:00
2021-03-23 23:13:35 +01:00
Removes defined arguments in defined methods and their calls.
2021-01-28 19:26:56 +01:00
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\Removing\Rector\ClassMethod\ArgumentRemoverRector` ](../rules/Removing/Rector/ClassMethod/ArgumentRemoverRector.php )
2021-01-28 19:26:56 +01:00
```diff
2021-03-23 23:13:35 +01:00
$someObject = new SomeClass;
-$someObject->someMethod(true);
2021-08-01 00:25:55 +00:00
+$someObject->someMethod();
2021-01-28 19:26:56 +01:00
```
< br >
2021-03-23 23:13:35 +01:00
### RemoveFuncCallArgRector
2020-11-16 17:50:38 +00:00
2021-03-23 23:13:35 +01:00
Remove argument by position by function name
2020-11-16 17:50:38 +00:00
2020-11-25 22:34:34 +01:00
:wrench: **configure it!**
2020-10-10 18:27:13 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Removing\Rector\FuncCall\RemoveFuncCallArgRector` ](../rules/Removing/Rector/FuncCall/RemoveFuncCallArgRector.php )
2020-10-10 18:27:13 +02:00
2019-09-25 10:49:53 +02:00
```diff
2021-03-23 23:13:35 +01:00
-remove_last_arg(1, 2);
+remove_last_arg(1);
2019-09-25 10:49:53 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-09-25 10:49:53 +02:00
2023-04-10 08:19:12 +00:00
### RemoveFuncCallRector
Remove function
:wrench: **configure it!**
- class: [`Rector\Removing\Rector\FuncCall\RemoveFuncCallRector` ](../rules/Removing/Rector/FuncCall/RemoveFuncCallRector.php )
```diff
-$x = 'something';
-var_dump($x);
+$x = 'something';
```
< br >
2021-03-23 23:13:35 +01:00
### RemoveInterfacesRector
2019-05-19 10:27:38 +02:00
2021-03-23 23:13:35 +01:00
Removes interfaces usage from class.
2019-05-19 10:27:38 +02:00
2020-11-25 22:34:34 +01:00
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\Removing\Rector\Class_\RemoveInterfacesRector` ](../rules/Removing/Rector/Class_/RemoveInterfacesRector.php )
2020-11-25 22:34:34 +01:00
2019-05-19 10:27:38 +02:00
```diff
2021-03-23 23:13:35 +01:00
-class SomeClass implements SomeInterface
+class SomeClass
2020-11-25 22:34:34 +01:00
{
}
2019-05-19 10:27:38 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-05-19 10:27:38 +02:00
2021-07-22 18:40:24 +00:00
### RemoveTraitUseRector
2020-10-30 14:25:24 +01:00
2021-03-23 23:13:35 +01:00
Remove specific traits from code
2020-10-30 14:25:24 +01:00
2021-03-23 23:13:35 +01:00
:wrench: **configure it!**
2020-11-25 22:34:34 +01:00
2021-07-22 18:40:24 +00:00
- class: [`Rector\Removing\Rector\Class_\RemoveTraitUseRector` ](../rules/Removing/Rector/Class_/RemoveTraitUseRector.php )
2020-10-30 14:25:24 +01:00
2020-11-16 17:50:38 +00:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
2020-11-25 22:34:34 +01:00
{
2021-03-23 23:13:35 +01:00
- use SomeTrait;
2020-11-25 22:34:34 +01:00
}
2020-11-16 17:50:38 +00:00
```
2020-07-24 13:46:57 +02:00
2020-11-16 17:50:38 +00:00
< br >
2020-09-24 20:54:39 +02:00
2021-03-23 23:13:35 +01:00
## Renaming
2020-12-22 16:48:25 +01:00
2021-03-23 23:13:35 +01:00
### RenameAnnotationRector
2020-12-22 16:48:25 +01:00
2021-03-23 23:13:35 +01:00
Turns defined annotations above properties and methods to their new values.
2020-12-22 16:48:25 +01:00
2021-03-23 23:13:35 +01:00
:wrench: **configure it!**
2020-12-22 16:48:25 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Renaming\Rector\ClassMethod\RenameAnnotationRector` ](../rules/Renaming/Rector/ClassMethod/RenameAnnotationRector.php )
2019-11-07 00:52:19 +01:00
2020-07-28 17:15:30 +02:00
```diff
2021-12-05 00:35:40 +00:00
use PHPUnit\Framework\TestCase;
final class SomeTest extends TestCase
2020-12-22 16:48:25 +01:00
{
2021-03-23 23:13:35 +01:00
/**
- * @test
+ * @scenario
*/
public function someMethod()
2020-12-22 16:48:25 +01:00
{
}
2020-07-28 17:15:30 +02:00
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-07-28 17:15:30 +02:00
2021-03-23 23:13:35 +01:00
### RenameClassConstFetchRector
2020-12-22 16:48:25 +01:00
2021-03-23 23:13:35 +01:00
Replaces defined class constants in their calls.
2020-12-22 16:48:25 +01:00
2021-03-23 23:13:35 +01:00
:wrench: **configure it!**
2020-12-22 16:48:25 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Renaming\Rector\ClassConstFetch\RenameClassConstFetchRector` ](../rules/Renaming/Rector/ClassConstFetch/RenameClassConstFetchRector.php )
2020-12-22 16:48:25 +01:00
```diff
2021-03-23 23:13:35 +01:00
-$value = SomeClass::OLD_CONSTANT;
-$value = SomeClass::OTHER_OLD_CONSTANT;
+$value = SomeClass::NEW_CONSTANT;
+$value = DifferentClass::NEW_CONSTANT;
2020-12-22 16:48:25 +01:00
```
< br >
2021-03-23 23:13:35 +01:00
### RenameClassRector
2020-07-24 13:46:57 +02:00
2021-03-23 23:13:35 +01:00
Replaces defined classes by new ones.
2019-02-04 01:32:53 +01:00
2021-03-23 23:13:35 +01:00
:wrench: **configure it!**
2019-02-04 01:32:53 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Renaming\Rector\Name\RenameClassRector` ](../rules/Renaming/Rector/Name/RenameClassRector.php )
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
```diff
namespace App;
2020-07-29 01:41:20 +02:00
2021-03-23 23:13:35 +01:00
-use SomeOldClass;
+use SomeNewClass;
2018-08-01 22:09:34 +02:00
2021-03-23 23:13:35 +01:00
-function someFunction(SomeOldClass $someOldClass): SomeOldClass
+function someFunction(SomeNewClass $someOldClass): SomeNewClass
2020-11-16 17:50:38 +00:00
{
2021-03-23 23:13:35 +01:00
- if ($someOldClass instanceof SomeOldClass) {
- return new SomeOldClass;
+ if ($someOldClass instanceof SomeNewClass) {
+ return new SomeNewClass;
2020-11-16 17:50:38 +00:00
}
}
2018-08-01 15:34:55 +02:00
```
2018-07-31 21:43:39 +02:00
2020-11-16 17:50:38 +00:00
< br >
2019-05-29 15:40:20 +02:00
2021-03-23 23:13:35 +01:00
### RenameConstantRector
2019-05-29 15:40:20 +02:00
2021-03-23 23:13:35 +01:00
Replace constant by new ones
2019-05-29 15:40:20 +02:00
2021-03-23 23:13:35 +01:00
:wrench: **configure it!**
2019-05-29 15:40:20 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Renaming\Rector\ConstFetch\RenameConstantRector` ](../rules/Renaming/Rector/ConstFetch/RenameConstantRector.php )
2020-07-24 13:46:57 +02:00
2021-03-23 23:13:35 +01:00
```diff
final class SomeClass
2020-12-22 16:48:25 +01:00
{
2021-03-23 23:13:35 +01:00
public function run()
2020-12-22 16:48:25 +01:00
{
2021-03-23 23:13:35 +01:00
- return MYSQL_ASSOC;
+ return MYSQLI_ASSOC;
2020-12-22 16:48:25 +01:00
}
}
```
< br >
2021-03-23 23:13:35 +01:00
### RenameFunctionRector
2020-12-22 16:48:25 +01:00
2021-03-23 23:13:35 +01:00
Turns defined function call new one.
2020-12-22 16:48:25 +01:00
2021-03-23 23:13:35 +01:00
:wrench: **configure it!**
2020-12-22 16:48:25 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Renaming\Rector\FuncCall\RenameFunctionRector` ](../rules/Renaming/Rector/FuncCall/RenameFunctionRector.php )
2020-12-22 16:48:25 +01:00
```diff
2021-03-23 23:13:35 +01:00
-view("...", []);
+Laravel\Templating\render("...", []);
2020-12-22 16:48:25 +01:00
```
< br >
2021-03-23 23:13:35 +01:00
### RenameMethodRector
2020-12-22 16:48:25 +01:00
2021-03-23 23:13:35 +01:00
Turns method names to new ones.
2020-12-22 16:48:25 +01:00
2021-03-23 23:13:35 +01:00
:wrench: **configure it!**
2020-12-22 16:48:25 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Renaming\Rector\MethodCall\RenameMethodRector` ](../rules/Renaming/Rector/MethodCall/RenameMethodRector.php )
2020-12-22 16:48:25 +01:00
```diff
2021-03-23 23:13:35 +01:00
$someObject = new SomeExampleClass;
-$someObject->oldMethod();
+$someObject->newMethod();
2020-12-22 16:48:25 +01:00
```
< br >
2021-03-23 23:13:35 +01:00
### RenamePropertyRector
2018-11-11 13:22:35 +01:00
2021-03-23 23:13:35 +01:00
Replaces defined old properties by new ones.
2019-02-04 01:32:53 +01:00
2020-11-16 17:50:38 +00:00
:wrench: **configure it!**
2019-02-04 01:32:53 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Renaming\Rector\PropertyFetch\RenamePropertyRector` ](../rules/Renaming/Rector/PropertyFetch/RenamePropertyRector.php )
2020-11-16 17:50:38 +00:00
2020-07-29 01:41:20 +02:00
```diff
2021-03-23 23:13:35 +01:00
-$someObject->someOldProperty;
+$someObject->someNewProperty;
2020-07-29 01:41:20 +02:00
```
2020-07-24 13:46:57 +02:00
2020-11-16 17:50:38 +00:00
< br >
2020-07-24 13:46:57 +02:00
2021-03-23 23:13:35 +01:00
### RenameStaticMethodRector
2020-11-16 17:50:38 +00:00
2021-03-23 23:13:35 +01:00
Turns method names to new ones.
2020-11-16 17:50:38 +00:00
2021-03-23 23:13:35 +01:00
:wrench: **configure it!**
2020-11-16 17:50:38 +00:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Renaming\Rector\StaticCall\RenameStaticMethodRector` ](../rules/Renaming/Rector/StaticCall/RenameStaticMethodRector.php )
2020-11-16 17:50:38 +00:00
2019-06-02 10:45:37 +03:00
```diff
2021-03-23 23:13:35 +01:00
-SomeClass::oldStaticMethod();
+AnotherExampleClass::newStaticMethod();
2019-05-29 15:40:20 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2019-05-29 15:40:20 +02:00
2021-03-23 23:13:35 +01:00
### RenameStringRector
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
Change string value
2020-11-25 22:34:34 +01:00
2021-03-23 23:13:35 +01:00
:wrench: **configure it!**
2020-11-25 22:34:34 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Renaming\Rector\String_\RenameStringRector` ](../rules/Renaming/Rector/String_/RenameStringRector.php )
2020-11-25 22:34:34 +01:00
2020-10-25 14:43:05 +01:00
```diff
2021-03-23 23:13:35 +01:00
class SomeClass
2020-11-16 17:50:38 +00:00
{
2021-03-23 23:13:35 +01:00
public function run()
2020-11-16 17:50:38 +00:00
{
2021-03-23 23:13:35 +01:00
- return 'ROLE_PREVIOUS_ADMIN';
+ return 'IS_IMPERSONATOR';
2020-11-16 17:50:38 +00:00
}
}
```
2020-09-24 20:54:39 +02:00
2020-11-16 17:50:38 +00:00
< br >
2020-07-30 01:39:41 +02:00
2021-10-05 08:51:30 +00:00
## Strict
### BooleanInBooleanNotRuleFixerRector
Fixer for PHPStan reports by strict type rule - "PHPStan\Rules\BooleansInConditions\BooleanInBooleanNotRule"
2021-10-05 15:59:39 +00:00
:wrench: **configure it!**
2021-10-05 08:51:30 +00:00
- class: [`Rector\Strict\Rector\BooleanNot\BooleanInBooleanNotRuleFixerRector` ](../rules/Strict/Rector/BooleanNot/BooleanInBooleanNotRuleFixerRector.php )
```diff
class SomeClass
{
2022-04-10 06:08:51 +00:00
public function run(string|null $name)
2021-10-05 08:51:30 +00:00
{
- if (! $name) {
2021-10-05 15:59:39 +00:00
+ if ($name === null) {
2021-10-05 11:12:46 +00:00
return 'no name';
2021-10-05 08:51:30 +00:00
}
2021-10-05 11:12:46 +00:00
return 'name';
2021-10-05 08:51:30 +00:00
}
}
```
< br >
### BooleanInIfConditionRuleFixerRector
Fixer for PHPStan reports by strict type rule - "PHPStan\Rules\BooleansInConditions\BooleanInIfConditionRule"
2021-10-05 15:59:39 +00:00
:wrench: **configure it!**
2021-10-05 08:51:30 +00:00
- class: [`Rector\Strict\Rector\If_\BooleanInIfConditionRuleFixerRector` ](../rules/Strict/Rector/If_/BooleanInIfConditionRuleFixerRector.php )
```diff
final class NegatedString
{
public function run(string $name)
{
- if ($name) {
+ if ($name !== '') {
return 'name';
}
return 'no name';
}
}
```
< br >
### BooleanInTernaryOperatorRuleFixerRector
Fixer for PHPStan reports by strict type rule - "PHPStan\Rules\BooleansInConditions\BooleanInTernaryOperatorRule"
2021-10-05 15:59:39 +00:00
:wrench: **configure it!**
2021-10-05 08:51:30 +00:00
- class: [`Rector\Strict\Rector\Ternary\BooleanInTernaryOperatorRuleFixerRector` ](../rules/Strict/Rector/Ternary/BooleanInTernaryOperatorRuleFixerRector.php )
```diff
final class ArrayCompare
{
public function run(array $data)
{
- return $data ? 1 : 2;
+ return $data !== [] ? 1 : 2;
}
}
```
< br >
### DisallowedEmptyRuleFixerRector
Fixer for PHPStan reports by strict type rule - "PHPStan\Rules\DisallowedConstructs\DisallowedEmptyRule"
2021-10-05 15:59:39 +00:00
:wrench: **configure it!**
2021-10-05 08:51:30 +00:00
- class: [`Rector\Strict\Rector\Empty_\DisallowedEmptyRuleFixerRector` ](../rules/Strict/Rector/Empty_/DisallowedEmptyRuleFixerRector.php )
```diff
final class SomeEmptyArray
{
public function run(array $items)
{
- return empty($items);
+ return $items === [];
}
}
```
< br >
### DisallowedShortTernaryRuleFixerRector
Fixer for PHPStan reports by strict type rule - "PHPStan\Rules\DisallowedConstructs\DisallowedShortTernaryRule"
2021-10-05 15:59:39 +00:00
:wrench: **configure it!**
2021-10-05 08:51:30 +00:00
- class: [`Rector\Strict\Rector\Ternary\DisallowedShortTernaryRuleFixerRector` ](../rules/Strict/Rector/Ternary/DisallowedShortTernaryRuleFixerRector.php )
```diff
final class ShortTernaryArray
{
public function run(array $array)
{
- return $array ?: 2;
+ return $array !== [] ? $array : 2;
}
}
```
< br >
2021-03-23 23:13:35 +01:00
## Transform
2021-01-30 21:30:37 +01:00
2021-11-26 20:07:54 +00:00
### AddAllowDynamicPropertiesAttributeRector
Add the `AllowDynamicProperties` attribute to all classes
2021-12-10 07:56:16 +00:00
:wrench: **configure it!**
2021-11-26 20:07:54 +00:00
- class: [`Rector\Transform\Rector\Class_\AddAllowDynamicPropertiesAttributeRector` ](../rules/Transform/Rector/Class_/AddAllowDynamicPropertiesAttributeRector.php )
```diff
2021-12-10 07:56:16 +00:00
namespace Example\Domain;
2021-11-26 20:07:54 +00:00
+#[AllowDynamicProperties]
class SomeObject {
public string $someProperty = 'hello world';
}
```
< br >
2021-02-21 00:02:05 +01:00
### AddInterfaceByTraitRector
Add interface by used trait
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\Transform\Rector\Class_\AddInterfaceByTraitRector` ](../rules/Transform/Rector/Class_/AddInterfaceByTraitRector.php )
2021-02-21 00:02:05 +01:00
```diff
-class SomeClass
+class SomeClass implements SomeInterface
{
use SomeTrait;
}
```
< br >
2021-10-14 15:36:34 +00:00
### AttributeKeyToClassConstFetchRector
Replace key value on specific attribute to class constant
:wrench: **configure it!**
- class: [`Rector\Transform\Rector\Attribute\AttributeKeyToClassConstFetchRector` ](../rules/Transform/Rector/Attribute/AttributeKeyToClassConstFetchRector.php )
```diff
use Doctrine\ORM\Mapping\Column;
+use Doctrine\DBAL\Types\Types;
class SomeClass
{
- #[Column(type: "string")]
+ #[Column(type: Types::STRING)]
public $name;
}
```
< br >
2021-02-21 10:40:54 +01:00
### FuncCallToConstFetchRector
Changes use of function calls to use constants
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\Transform\Rector\FuncCall\FuncCallToConstFetchRector` ](../rules/Transform/Rector/FuncCall/FuncCallToConstFetchRector.php )
2021-02-21 10:40:54 +01:00
```diff
class SomeClass
{
public function run()
{
- $value = php_sapi_name();
+ $value = PHP_SAPI;
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### FuncCallToMethodCallRector
2020-08-30 20:48:37 +02:00
2020-11-25 22:34:34 +01:00
Turns defined function calls to local method calls.
2020-08-30 20:48:37 +02:00
2020-11-25 22:34:34 +01:00
:wrench: **configure it!**
2020-08-30 20:48:37 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Transform\Rector\FuncCall\FuncCallToMethodCallRector` ](../rules/Transform/Rector/FuncCall/FuncCallToMethodCallRector.php )
2020-11-25 22:34:34 +01:00
2020-08-30 20:48:37 +02:00
```diff
class SomeClass
{
2020-11-25 22:34:34 +01:00
+ /**
+ * @var \Namespaced\SomeRenderer
+ */
+ private $someRenderer;
+
+ public function __construct(\Namespaced\SomeRenderer $someRenderer)
+ {
+ $this->someRenderer = $someRenderer;
+ }
+
public function run()
2020-08-30 20:48:37 +02:00
{
2020-11-25 22:34:34 +01:00
- view('...');
+ $this->someRenderer->view('...');
2020-08-30 20:48:37 +02:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-08-31 10:48:14 +02:00
2021-01-30 21:30:37 +01:00
### FuncCallToNewRector
Change configured function calls to new Instance
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\Transform\Rector\FuncCall\FuncCallToNewRector` ](../rules/Transform/Rector/FuncCall/FuncCallToNewRector.php )
2021-01-30 21:30:37 +01:00
```diff
class SomeClass
{
public function run()
{
- $array = collection([]);
+ $array = new \Collection([]);
}
}
```
< br >
### FuncCallToStaticCallRector
Turns defined function call to static method call.
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\Transform\Rector\FuncCall\FuncCallToStaticCallRector` ](../rules/Transform/Rector/FuncCall/FuncCallToStaticCallRector.php )
2021-01-30 21:30:37 +01:00
```diff
-view("...", []);
+SomeClass::render("...", []);
```
< br >
2021-02-21 00:02:05 +01:00
### MergeInterfacesRector
Merges old interface to a new one, that already has its methods
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\Transform\Rector\Class_\MergeInterfacesRector` ](../rules/Transform/Rector/Class_/MergeInterfacesRector.php )
2021-02-21 00:02:05 +01:00
```diff
-class SomeClass implements SomeInterface, SomeOldInterface
+class SomeClass implements SomeInterface
{
}
```
< br >
2023-02-19 13:39:22 +00:00
### MethodCallToFuncCallRector
Change method call to function call
:wrench: **configure it!**
- class: [`Rector\Transform\Rector\MethodCall\MethodCallToFuncCallRector` ](../rules/Transform/Rector/MethodCall/MethodCallToFuncCallRector.php )
```diff
final class SomeClass
{
public function show()
{
- return $this->render('some_template');
+ return view('some_template');
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### MethodCallToPropertyFetchRector
2020-08-30 15:47:36 +02:00
2020-11-25 22:34:34 +01:00
Turns method call `"$this->something()"` to property fetch "$this->something"
2020-09-24 20:54:39 +02:00
2020-11-16 17:50:38 +00:00
:wrench: **configure it!**
2020-08-30 15:47:36 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Transform\Rector\MethodCall\MethodCallToPropertyFetchRector` ](../rules/Transform/Rector/MethodCall/MethodCallToPropertyFetchRector.php )
2020-08-30 15:47:36 +02:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
{
public function run()
{
- $this->someMethod();
+ $this->someProperty;
}
}
2020-08-30 15:47:36 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-10-27 01:42:04 +01:00
2020-11-25 22:34:34 +01:00
### MethodCallToStaticCallRector
Change method call to desired static call
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\Transform\Rector\MethodCall\MethodCallToStaticCallRector` ](../rules/Transform/Rector/MethodCall/MethodCallToStaticCallRector.php )
2020-11-25 22:34:34 +01:00
2020-10-27 01:42:04 +01:00
```diff
2020-11-25 22:34:34 +01:00
final class SomeClass
{
private $anotherDependency;
public function __construct(AnotherDependency $anotherDependency)
{
$this->anotherDependency = $anotherDependency;
}
public function loadConfiguration()
{
- return $this->anotherDependency->process('value');
+ return StaticCaller::anotherMethod('value');
}
}
2020-10-27 01:42:04 +01:00
```
2020-11-16 17:50:38 +00:00
< br >
2020-10-27 01:42:04 +01:00
2021-01-30 21:30:37 +01:00
### NewToStaticCallRector
Change new Object to static call
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\Transform\Rector\New_\NewToStaticCallRector` ](../rules/Transform/Rector/New_/NewToStaticCallRector.php )
2021-01-30 21:30:37 +01:00
2021-01-24 10:07:23 +01:00
```diff
class SomeClass
{
public function run()
{
2021-01-30 21:30:37 +01:00
- new Cookie($name);
+ Cookie::create($name);
2021-01-24 10:07:23 +01:00
}
}
```
< br >
2021-01-30 21:30:37 +01:00
### ParentClassToTraitsRector
2020-08-30 20:48:37 +02:00
2021-01-30 21:30:37 +01:00
Replaces parent class to specific traits
2020-08-30 20:48:37 +02:00
2020-11-25 22:34:34 +01:00
:wrench: **configure it!**
2020-08-30 20:48:37 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Transform\Rector\Class_\ParentClassToTraitsRector` ](../rules/Transform/Rector/Class_/ParentClassToTraitsRector.php )
2020-09-24 20:54:39 +02:00
2020-08-30 20:48:37 +02:00
```diff
2021-01-30 21:30:37 +01:00
-class SomeClass extends Nette\Object
+class SomeClass
2020-08-30 20:48:37 +02:00
{
2021-01-30 21:30:37 +01:00
+ use Nette\SmartObject;
2020-11-16 17:50:38 +00:00
}
```
2020-08-30 20:48:37 +02:00
2020-11-16 17:50:38 +00:00
< br >
2020-11-25 22:34:34 +01:00
### PropertyAssignToMethodCallRector
2020-11-16 17:50:38 +00:00
2020-11-25 22:34:34 +01:00
Turns property assign of specific type and property name to method call
2020-11-16 17:50:38 +00:00
2020-11-25 22:34:34 +01:00
:wrench: **configure it!**
2020-11-16 17:50:38 +00:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Transform\Rector\Assign\PropertyAssignToMethodCallRector` ](../rules/Transform/Rector/Assign/PropertyAssignToMethodCallRector.php )
2020-08-30 20:48:37 +02:00
2020-11-16 17:50:38 +00:00
```diff
2020-11-25 22:34:34 +01:00
$someObject = new SomeClass;
-$someObject->oldProperty = false;
+$someObject->newMethodCall(false);
2020-11-16 17:50:38 +00:00
```
2020-08-30 20:48:37 +02:00
2020-11-16 17:50:38 +00:00
< br >
2020-09-24 20:54:39 +02:00
2021-01-30 21:30:37 +01:00
### PropertyFetchToMethodCallRector
2020-08-30 20:48:37 +02:00
2020-11-25 22:34:34 +01:00
Replaces properties assign calls be defined methods.
2020-09-24 20:54:39 +02:00
2020-11-25 22:34:34 +01:00
:wrench: **configure it!**
2020-11-16 17:50:38 +00:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Transform\Rector\Assign\PropertyFetchToMethodCallRector` ](../rules/Transform/Rector/Assign/PropertyFetchToMethodCallRector.php )
2020-08-30 20:48:37 +02:00
```diff
2020-11-25 22:34:34 +01:00
-$result = $object->property;
-$object->property = $value;
+$result = $object->getProperty();
+$object->setProperty($value);
2021-12-07 19:04:47 +00:00
-$bare = $object->bareProperty;
+$bare = $object->getConfig('someArg');
2020-11-16 17:50:38 +00:00
```
2020-08-31 02:26:25 +02:00
2020-11-16 17:50:38 +00:00
< br >
2020-09-24 20:54:39 +02:00
2020-11-25 22:34:34 +01:00
### ReplaceParentCallByPropertyCallRector
2020-08-31 02:26:25 +02:00
2020-11-25 22:34:34 +01:00
Changes method calls in child of specific types to defined property method call
2020-09-24 20:54:39 +02:00
2020-11-25 22:34:34 +01:00
:wrench: **configure it!**
2020-11-16 17:50:38 +00:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Transform\Rector\MethodCall\ReplaceParentCallByPropertyCallRector` ](../rules/Transform/Rector/MethodCall/ReplaceParentCallByPropertyCallRector.php )
2020-08-31 02:26:25 +02:00
2020-11-16 17:50:38 +00:00
```diff
2020-11-25 22:34:34 +01:00
final class SomeClass
2020-08-31 02:26:25 +02:00
{
2020-11-25 22:34:34 +01:00
public function run(SomeTypeToReplace $someTypeToReplace)
2020-08-31 02:26:25 +02:00
{
2020-11-25 22:34:34 +01:00
- $someTypeToReplace->someMethodCall();
+ $this->someProperty->someMethodCall();
2020-08-31 02:26:25 +02:00
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-08-31 02:26:25 +02:00
2022-01-02 00:31:07 +00:00
### ReturnTypeWillChangeRector
2021-12-10 07:56:16 +00:00
2022-01-02 00:31:07 +00:00
Add #[\ReturnTypeWillChange] attribute to configured instanceof class with methods
2021-12-10 07:56:16 +00:00
:wrench: **configure it!**
2022-01-02 00:31:07 +00:00
- class: [`Rector\Transform\Rector\ClassMethod\ReturnTypeWillChangeRector` ](../rules/Transform/Rector/ClassMethod/ReturnTypeWillChangeRector.php )
2021-12-10 07:56:16 +00:00
```diff
2022-01-02 00:31:07 +00:00
class SomeClass implements ArrayAccess
2021-12-10 07:56:16 +00:00
{
2022-01-02 00:31:07 +00:00
+ #[\ReturnTypeWillChange]
public function offsetGet($offset)
2021-12-10 07:56:16 +00:00
{
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### StaticCallToFuncCallRector
2020-11-16 17:50:38 +00:00
2020-11-25 22:34:34 +01:00
Turns static call to function call.
2020-11-16 17:50:38 +00:00
2020-11-25 22:34:34 +01:00
:wrench: **configure it!**
2020-11-16 17:50:38 +00:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Transform\Rector\StaticCall\StaticCallToFuncCallRector` ](../rules/Transform/Rector/StaticCall/StaticCallToFuncCallRector.php )
2019-06-02 10:45:37 +03:00
2019-05-29 15:40:20 +02:00
```diff
2020-11-25 22:34:34 +01:00
-OldClass::oldMethod("args");
+new_function("args");
2018-07-31 14:50:39 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-11-11 13:22:35 +01:00
2020-11-25 22:34:34 +01:00
### StaticCallToMethodCallRector
2018-07-31 21:43:39 +02:00
2020-11-25 22:34:34 +01:00
Change static call to service method via constructor injection
2018-05-04 23:30:32 +01:00
2020-11-25 22:34:34 +01:00
:wrench: **configure it!**
2018-08-01 22:09:34 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\Transform\Rector\StaticCall\StaticCallToMethodCallRector` ](../rules/Transform/Rector/StaticCall/StaticCallToMethodCallRector.php )
2020-11-25 22:34:34 +01:00
2020-11-16 17:50:38 +00:00
```diff
2020-11-25 22:34:34 +01:00
-use Nette\Utils\FileSystem;
2022-09-03 08:03:15 +00:00
+use App\Custom\SmartFileSystem;
2020-11-25 22:34:34 +01:00
class SomeClass
{
+ /**
+ * @var SmartFileSystem
+ */
+ private $smartFileSystem;
+
+ public function __construct(SmartFileSystem $smartFileSystem)
+ {
+ $this->smartFileSystem = $smartFileSystem;
+ }
+
public function run()
{
- return FileSystem::write('file', 'content');
+ return $this->smartFileSystem->dumpFile('file', 'content');
}
}
2018-08-01 22:09:34 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-11-11 13:22:35 +01:00
2021-01-28 19:26:56 +01:00
### StaticCallToNewRector
Change static call to new instance
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\Transform\Rector\StaticCall\StaticCallToNewRector` ](../rules/Transform/Rector/StaticCall/StaticCallToNewRector.php )
2021-01-28 19:26:56 +01:00
```diff
class SomeClass
{
public function run()
{
2021-11-28 17:29:16 +00:00
- $dotenv = JsonResponse::create(['foo' => 'bar'], Response::HTTP_OK);
+ $dotenv = new JsonResponse(['foo' => 'bar'], Response::HTTP_OK);
2021-01-28 19:26:56 +01:00
}
}
```
< br >
2021-01-30 21:30:37 +01:00
### StringToClassConstantRector
Changes strings to specific constants
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\Transform\Rector\String_\StringToClassConstantRector` ](../rules/Transform/Rector/String_/StringToClassConstantRector.php )
2021-01-30 21:30:37 +01:00
```diff
final class SomeSubscriber
{
public static function getSubscribedEvents()
{
- return ['compiler.post_dump' => 'compile'];
+ return [\Yet\AnotherClass::CONSTANT => 'compile'];
}
}
```
< br >
2021-02-21 00:21:19 +01:00
### WrapReturnRector
Wrap return value of specific method
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\Transform\Rector\ClassMethod\WrapReturnRector` ](../rules/Transform/Rector/ClassMethod/WrapReturnRector.php )
2021-02-21 00:21:19 +01:00
```diff
final class SomeClass
{
public function getItem()
{
- return 1;
+ return [1];
}
}
```
< br >
2020-11-25 22:34:34 +01:00
## TypeDeclaration
2020-07-24 13:46:57 +02:00
2022-09-18 00:40:19 +00:00
### AddArrowFunctionReturnTypeRector
Add known return type to arrow function
- class: [`Rector\TypeDeclaration\Rector\ArrowFunction\AddArrowFunctionReturnTypeRector` ](../rules/TypeDeclaration/Rector/ArrowFunction/AddArrowFunctionReturnTypeRector.php )
```diff
-fn () => [];
+fn (): array => [];
```
< br >
2021-02-21 00:02:05 +01:00
### AddMethodCallBasedStrictParamTypeRector
2018-08-01 22:09:34 +02:00
2021-10-28 22:22:07 +00:00
Change private method param type to strict type, based on passed strict types
2020-11-16 17:50:38 +00:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\AddMethodCallBasedStrictParamTypeRector` ](../rules/TypeDeclaration/Rector/ClassMethod/AddMethodCallBasedStrictParamTypeRector.php )
2018-08-01 22:09:34 +02:00
2018-05-04 23:30:32 +01:00
```diff
2021-10-28 22:22:07 +00:00
final class SomeClass
2020-11-16 17:50:38 +00:00
{
2021-10-28 22:22:07 +00:00
public function run(int $value)
2020-11-16 17:50:38 +00:00
{
2021-10-28 22:22:07 +00:00
$this->resolve($value);
2021-02-21 00:02:05 +01:00
}
2021-10-28 22:22:07 +00:00
- private function resolve($value)
+ private function resolve(int $value)
2021-02-21 00:02:05 +01:00
{
2020-11-16 17:50:38 +00:00
}
}
2018-07-31 08:38:48 +02:00
```
2020-11-16 17:50:38 +00:00
< br >
2018-11-11 13:22:35 +01:00
2022-11-27 17:56:33 +00:00
### AddParamTypeBasedOnPHPUnitDataProviderRector
Adds param type declaration based on PHPUnit provider return type declaration
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\AddParamTypeBasedOnPHPUnitDataProviderRector` ](../rules/TypeDeclaration/Rector/ClassMethod/AddParamTypeBasedOnPHPUnitDataProviderRector.php )
```diff
2023-09-30 09:01:28 +00:00
use PHPUnit\Framework\TestCase;
2022-11-27 17:56:33 +00:00
final class SomeTest extends TestCase
{
/**
* @dataProvider provideData()
*/
- public function test($value)
+ public function test(string $value)
{
}
2023-02-06 09:25:47 +00:00
public static function provideData()
2022-11-27 17:56:33 +00:00
{
yield ['name'];
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### AddParamTypeDeclarationRector
2020-10-30 12:58:35 +01:00
2020-11-25 22:34:34 +01:00
Add param types where needed
2020-10-30 12:58:35 +01:00
2020-11-25 22:34:34 +01:00
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\AddParamTypeDeclarationRector` ](../rules/TypeDeclaration/Rector/ClassMethod/AddParamTypeDeclarationRector.php )
2020-11-25 22:34:34 +01:00
2020-11-16 17:50:38 +00:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2020-11-16 17:50:38 +00:00
{
2020-11-25 22:34:34 +01:00
- public function process($name)
+ public function process(string $name)
{
}
2020-11-16 17:50:38 +00:00
}
```
2020-10-30 12:58:35 +01:00
2020-11-16 17:50:38 +00:00
< br >
2020-10-30 12:58:35 +01:00
2022-11-27 23:03:34 +00:00
### AddParamTypeFromPropertyTypeRector
Adds param type declaration based on property type the value is assigned to PHPUnit provider return type declaration
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\AddParamTypeFromPropertyTypeRector` ](../rules/TypeDeclaration/Rector/ClassMethod/AddParamTypeFromPropertyTypeRector.php )
```diff
final class SomeClass
{
private string $name;
- public function setName($name)
+ public function setName(string $name)
{
$this->name = $name;
}
}
```
< br >
2022-11-27 21:07:35 +00:00
### AddParamTypeSplFixedArrayRector
Add exact fixed array type in known cases
- class: [`Rector\TypeDeclaration\Rector\FunctionLike\AddParamTypeSplFixedArrayRector` ](../rules/TypeDeclaration/Rector/FunctionLike/AddParamTypeSplFixedArrayRector.php )
```diff
+use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
class SomeClass
{
+ /**
+ * @param Tokens< Token >
+ */
public function run(Tokens $tokens)
{
}
}
```
< br >
2021-11-26 20:07:54 +00:00
### AddPropertyTypeDeclarationRector
Add type to property by added rules, mostly public/property by parent type
:wrench: **configure it!**
- class: [`Rector\TypeDeclaration\Rector\Property\AddPropertyTypeDeclarationRector` ](../rules/TypeDeclaration/Rector/Property/AddPropertyTypeDeclarationRector.php )
```diff
class SomeClass extends ParentClass
{
- public $name;
+ public string $name;
}
```
< br >
2022-07-24 00:40:22 +00:00
### AddReturnTypeDeclarationBasedOnParentClassMethodRector
Add missing return type declaration based on parent class method
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\AddReturnTypeDeclarationBasedOnParentClassMethodRector` ](../rules/TypeDeclaration/Rector/ClassMethod/AddReturnTypeDeclarationBasedOnParentClassMethodRector.php )
```diff
class A
{
public function execute(): int
{
}
}
class B extends A{
- public function execute()
+ public function execute(): int
{
}
}
```
< br >
2022-11-28 12:49:02 +00:00
### AddReturnTypeDeclarationFromYieldsRector
Add return type declarations from yields
- class: [`Rector\TypeDeclaration\Rector\FunctionLike\AddReturnTypeDeclarationFromYieldsRector` ](../rules/TypeDeclaration/Rector/FunctionLike/AddReturnTypeDeclarationFromYieldsRector.php )
```diff
class SomeClass
{
- public function provide()
+ /**
+ * @return Iterator< int >
+ */
+ public function provide(): Iterator
{
yield 1;
}
}
```
< br >
2020-11-25 22:34:34 +01:00
### AddReturnTypeDeclarationRector
2020-11-16 17:50:38 +00:00
2020-11-25 22:34:34 +01:00
Changes defined return typehint of method and class.
2020-11-16 17:50:38 +00:00
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\AddReturnTypeDeclarationRector` ](../rules/TypeDeclaration/Rector/ClassMethod/AddReturnTypeDeclarationRector.php )
2020-11-16 17:50:38 +00:00
2020-10-30 12:58:35 +01:00
```diff
2020-11-25 22:34:34 +01:00
class SomeClass
2020-10-30 12:58:35 +01:00
{
2021-07-22 18:40:24 +00:00
- public function getData()
+ public function getData(): array
2020-10-30 12:58:35 +01:00
{
}
}
```
2020-11-16 17:50:38 +00:00
< br >
2020-10-30 12:58:35 +01:00
2021-02-21 00:02:05 +01:00
### AddVoidReturnTypeWhereNoReturnRector
Add return type void to function like without any return
2021-05-23 09:33:26 +00:00
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\AddVoidReturnTypeWhereNoReturnRector` ](../rules/TypeDeclaration/Rector/ClassMethod/AddVoidReturnTypeWhereNoReturnRector.php )
2021-02-21 00:02:05 +01:00
```diff
final class SomeClass
{
- public function getValues()
+ public function getValues(): void
{
$value = 1000;
return;
}
}
```
< br >
2023-04-19 11:05:06 +00:00
### BinaryOpNullableToInstanceofRector
Change & & and || between nullable objects to instanceof compares
- class: [`Rector\TypeDeclaration\Rector\BooleanAnd\BinaryOpNullableToInstanceofRector` ](../rules/TypeDeclaration/Rector/BooleanAnd/BinaryOpNullableToInstanceofRector.php )
```diff
function someFunction(?SomeClass $someClass)
{
- if ($someClass && $someClass->someMethod()) {
+ if ($someClass instanceof SomeClass & & $someClass->someMethod()) {
return 'yes';
}
return 'no';
}
```
< br >
2023-05-19 15:03:57 +00:00
### BoolReturnTypeFromStrictScalarReturnsRector
Change return type based on strict returns type operations
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\BoolReturnTypeFromStrictScalarReturnsRector` ](../rules/TypeDeclaration/Rector/ClassMethod/BoolReturnTypeFromStrictScalarReturnsRector.php )
```diff
class SomeClass
{
- public function resolve($first, $second)
+ public function resolve($first, $second): bool
{
if ($first) {
return false;
}
return $first > $second;
}
}
```
< br >
2023-04-19 07:12:58 +00:00
### DeclareStrictTypesRector
Add declare(strict_types=1) if missing
- class: [`Rector\TypeDeclaration\Rector\StmtsAwareInterface\DeclareStrictTypesRector` ](../rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php )
```diff
+declare(strict_types=1);
+
function someFunction()
{
}
```
< br >
2022-12-20 21:37:46 +00:00
### EmptyOnNullableObjectToInstanceOfRector
Change `empty()` on nullable object to instanceof check
- class: [`Rector\TypeDeclaration\Rector\Empty_\EmptyOnNullableObjectToInstanceOfRector` ](../rules/TypeDeclaration/Rector/Empty_/EmptyOnNullableObjectToInstanceOfRector.php )
```diff
class SomeClass
{
public function run(?AnotherObject $anotherObject)
{
- if (empty($anotherObject)) {
+ if (! $anotherObject instanceof AnotherObject) {
return false;
}
return true;
}
}
```
< br >
2023-12-10 00:29:28 +00:00
### MergeDateTimePropertyTypeDeclarationRector
Set DateTime to DateTimeInterface for DateTime property with DateTimeInterface docblock
- class: [`Rector\TypeDeclaration\Rector\Class_\MergeDateTimePropertyTypeDeclarationRector` ](../rules/TypeDeclaration/Rector/Class_/MergeDateTimePropertyTypeDeclarationRector.php )
```diff
final class SomeClass
{
- /**
- * @var DateTimeInterface
- */
- private DateTime $dateTime;
+ private DateTimeInterface $dateTime;
}
```
< br >
2023-06-19 21:00:27 +00:00
### NumericReturnTypeFromStrictScalarReturnsRector
Change numeric return type based on strict returns type operations
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\NumericReturnTypeFromStrictScalarReturnsRector` ](../rules/TypeDeclaration/Rector/ClassMethod/NumericReturnTypeFromStrictScalarReturnsRector.php )
```diff
class SomeClass
{
- public function resolve(int $first, int $second)
+ public function resolve(int $first, int $second): int
{
return $first - $second;
}
}
```
< br >
2023-04-16 00:32:04 +00:00
2021-08-01 00:25:55 +00:00
### ParamTypeByMethodCallTypeRector
Change param type based on passed method call type
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ParamTypeByMethodCallTypeRector` ](../rules/TypeDeclaration/Rector/ClassMethod/ParamTypeByMethodCallTypeRector.php )
```diff
class SomeTypedService
{
public function run(string $name)
{
}
}
final class UseDependency
{
public function __construct(
private SomeTypedService $someTypedService
) {
}
- public function go($value)
+ public function go(string $value)
{
$this->someTypedService->run($value);
}
}
```
< br >
### ParamTypeByParentCallTypeRector
Change param type based on parent param type
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ParamTypeByParentCallTypeRector` ](../rules/TypeDeclaration/Rector/ClassMethod/ParamTypeByParentCallTypeRector.php )
```diff
class SomeControl
{
public function __construct(string $name)
{
}
}
class VideoControl extends SomeControl
{
- public function __construct($name)
+ public function __construct(string $name)
{
parent::__construct($name);
}
}
```
< br >
2023-01-28 16:20:41 +00:00
### PropertyTypeFromStrictSetterGetterRector
Add property type based on strict setter and getter method
- class: [`Rector\TypeDeclaration\Rector\Class_\PropertyTypeFromStrictSetterGetterRector` ](../rules/TypeDeclaration/Rector/Class_/PropertyTypeFromStrictSetterGetterRector.php )
```diff
final class SomeClass
{
- private $name = 'John';
+ private string $name = 'John';
public function setName(string $name): void
{
$this->name = $name;
}
public function getName(): string
{
return $this->name;
}
}
```
< br >
2021-05-09 02:15:50 +02:00
### ReturnNeverTypeRector
2021-07-22 18:40:24 +00:00
Add "never" return-type for methods that never return anything
2021-05-09 02:15:50 +02:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ReturnNeverTypeRector` ](../rules/TypeDeclaration/Rector/ClassMethod/ReturnNeverTypeRector.php )
2021-05-09 02:15:50 +02:00
```diff
final class SomeClass
{
2023-05-14 22:40:25 +00:00
- public function run()
+ public function run(): never
2021-05-09 02:15:50 +02:00
{
throw new InvalidException();
}
}
```
< br >
2022-11-29 15:48:49 +00:00
### ReturnTypeFromReturnDirectArrayRector
Add return type from return direct array
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromReturnDirectArrayRector` ](../rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromReturnDirectArrayRector.php )
```diff
final class AddReturnArray
{
- public function getArray()
+ public function getArray(): array
{
return [1, 2, 3];
}
}
```
< br >
2021-02-21 00:02:05 +01:00
### ReturnTypeFromReturnNewRector
2021-06-06 07:59:41 +00:00
Add return type to function like with return new
2021-02-21 00:02:05 +01:00
2021-05-23 09:33:26 +00:00
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromReturnNewRector` ](../rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromReturnNewRector.php )
2021-02-21 00:02:05 +01:00
```diff
final class SomeClass
{
- public function action()
2021-06-21 19:24:28 +00:00
+ public function action(): Response
2021-02-21 00:02:05 +01:00
{
return new Response();
}
}
```
< br >
2022-06-26 10:02:03 +00:00
### ReturnTypeFromStrictBoolReturnExprRector
2022-06-25 14:38:11 +00:00
Add strict return type based on returned strict expr type
2022-06-26 10:02:03 +00:00
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictBoolReturnExprRector` ](../rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictBoolReturnExprRector.php )
2022-06-25 14:38:11 +00:00
```diff
final class SomeClass
{
2022-06-25 15:02:55 +00:00
- public function run()
+ public function run(): bool
2022-06-25 14:38:11 +00:00
{
2022-06-25 15:02:55 +00:00
return $this->first() & & $this->somethingElse();
2022-06-25 14:38:11 +00:00
}
}
```
< br >
2022-11-29 15:48:49 +00:00
### ReturnTypeFromStrictConstantReturnRector
Add strict type declaration based on returned constants
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictConstantReturnRector` ](../rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictConstantReturnRector.php )
```diff
class SomeClass
{
public const NAME = 'name';
- public function run()
+ public function run(): string
{
return self::NAME;
}
}
```
< br >
2023-09-05 13:21:31 +00:00
### ReturnTypeFromStrictFluentReturnRector
Add return type from strict return `$this`
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictFluentReturnRector` ](../rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictFluentReturnRector.php )
```diff
final class SomeClass
{
- public function run()
+ public function run(): self
{
return $this;
}
}
```
< br >
2022-07-09 14:14:37 +00:00
### ReturnTypeFromStrictNativeCallRector
2022-06-26 10:02:03 +00:00
2022-07-09 14:14:37 +00:00
Add strict return type based native function or class method return
2022-06-26 10:02:03 +00:00
2022-07-09 14:14:37 +00:00
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictNativeCallRector` ](../rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictNativeCallRector.php )
2022-06-26 10:02:03 +00:00
```diff
final class SomeClass
{
- public function run()
+ public function run(): int
{
return strlen('value');
}
}
```
< br >
2022-06-26 11:48:44 +00:00
### ReturnTypeFromStrictNewArrayRector
Add strict return array type based on created empty array and returned
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictNewArrayRector` ](../rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictNewArrayRector.php )
```diff
final class SomeClass
{
- public function run()
+ public function run(): array
{
$values = [];
return $values;
}
}
```
< br >
2023-07-16 00:38:13 +00:00
### ReturnTypeFromStrictParamRector
Add return type based on strict parameter type
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictParamRector` ](../rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictParamRector.php )
```diff
class SomeClass
{
- public function resolve(ParamType $item)
+ public function resolve(ParamType $item): ParamType
{
return $item;
}
}
```
< br >
2023-08-06 16:40:47 +00:00
### ReturnTypeFromStrictScalarReturnExprRector
Change return type based on strict scalar returns - string, int, float or bool
2023-12-30 11:58:36 +00:00
:wrench: **configure it!**
2023-08-06 16:40:47 +00:00
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictScalarReturnExprRector` ](../rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictScalarReturnExprRector.php )
```diff
final class SomeClass
{
2023-12-30 11:58:36 +00:00
- public function foo($value)
+ public function foo($value): string
2023-08-06 16:40:47 +00:00
{
if ($value) {
return 'yes';
}
return 'no';
}
2023-12-30 11:58:36 +00:00
- public function bar(string $value)
+ public function bar(string $value): int
{
return strlen($value);
}
2023-08-06 16:40:47 +00:00
}
```
< br >
2023-01-29 12:39:10 +00:00
### ReturnTypeFromStrictTernaryRector
Add method return type based on strict ternary values
- class: [`Rector\TypeDeclaration\Rector\Class_\ReturnTypeFromStrictTernaryRector` ](../rules/TypeDeclaration/Rector/Class_/ReturnTypeFromStrictTernaryRector.php )
```diff
final class SomeClass
{
- public function getValue($number)
+ public function getValue($number): int
{
return $number ? 100 : 500;
}
}
```
< br >
2022-11-29 15:48:49 +00:00
### ReturnTypeFromStrictTypedCallRector
Add return type from strict return type of call
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictTypedCallRector` ](../rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictTypedCallRector.php )
```diff
final class SomeClass
{
- public function getData()
+ public function getData(): int
{
return $this->getNumber();
}
private function getNumber(): int
{
return 1000;
}
}
```
< br >
2021-02-07 11:11:42 +01:00
### ReturnTypeFromStrictTypedPropertyRector
Add return method return type based on strict typed property
2021-05-23 09:33:26 +00:00
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictTypedPropertyRector` ](../rules/TypeDeclaration/Rector/ClassMethod/ReturnTypeFromStrictTypedPropertyRector.php )
2021-02-07 11:11:42 +01:00
```diff
final class SomeClass
{
private int $age = 100;
- public function getAge()
+ public function getAge(): int
{
return $this->age;
}
}
```
< br >
2023-08-05 10:29:33 +00:00
### ReturnUnionTypeRector
Add union return type
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ReturnUnionTypeRector` ](../rules/TypeDeclaration/Rector/ClassMethod/ReturnUnionTypeRector.php )
```diff
final class SomeClass
{
- public function getData()
+ public function getData(): null|\DateTime|\stdClass
{
if (rand(0, 1)) {
return null;
}
if (rand(0, 1)) {
return new DateTime('now');
}
return new stdClass;
}
}
```
< br >
2023-06-30 16:33:30 +00:00
### StrictArrayParamDimFetchRector
Add array type based on array dim fetch use
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\StrictArrayParamDimFetchRector` ](../rules/TypeDeclaration/Rector/ClassMethod/StrictArrayParamDimFetchRector.php )
```diff
class SomeClass
{
- public function resolve($item)
+ public function resolve(array $item)
{
return $item['name'];
}
}
```
< br >
2023-07-31 11:10:36 +00:00
### StrictStringParamConcatRector
Add string type based on concat use
- class: [`Rector\TypeDeclaration\Rector\ClassMethod\StrictStringParamConcatRector` ](../rules/TypeDeclaration/Rector/ClassMethod/StrictStringParamConcatRector.php )
```diff
class SomeClass
{
- public function resolve($item)
+ public function resolve(string $item)
{
return $item . ' world';
}
}
```
< br >
2021-12-15 00:48:30 +00:00
### TypedPropertyFromAssignsRector
Add typed property from assigned types
2022-04-13 16:35:59 +00:00
:wrench: **configure it!**
2021-12-15 00:48:30 +00:00
- class: [`Rector\TypeDeclaration\Rector\Property\TypedPropertyFromAssignsRector` ](../rules/TypeDeclaration/Rector/Property/TypedPropertyFromAssignsRector.php )
```diff
final class SomeClass
{
- private $name;
+ private string|null $name = null;
public function run()
{
$this->name = 'string';
}
}
```
< br >
2021-02-07 11:11:42 +01:00
### TypedPropertyFromStrictConstructorRector
Add typed properties based only on strict constructor types
2021-05-23 09:33:26 +00:00
- class: [`Rector\TypeDeclaration\Rector\Property\TypedPropertyFromStrictConstructorRector` ](../rules/TypeDeclaration/Rector/Property/TypedPropertyFromStrictConstructorRector.php )
2021-02-07 11:11:42 +01:00
```diff
class SomeObject
{
- private $name;
+ private string $name;
public function __construct(string $name)
{
$this->name = $name;
}
}
```
< br >
2022-07-06 11:56:20 +00:00
### TypedPropertyFromStrictSetUpRector
Add strict typed property based on `setUp()` strict typed assigns in TestCase
- class: [`Rector\TypeDeclaration\Rector\Property\TypedPropertyFromStrictSetUpRector` ](../rules/TypeDeclaration/Rector/Property/TypedPropertyFromStrictSetUpRector.php )
```diff
use PHPUnit\Framework\TestCase;
final class SomeClass extends TestCase
{
- private $value;
+ private int $value;
public function setUp()
{
$this->value = 1000;
}
}
```
< br >
2023-04-24 11:18:26 +00:00
### WhileNullableToInstanceofRector
Change while null compare to strict instanceof check
- class: [`Rector\TypeDeclaration\Rector\While_\WhileNullableToInstanceofRector` ](../rules/TypeDeclaration/Rector/While_/WhileNullableToInstanceofRector.php )
```diff
final class SomeClass
{
public function run(?SomeClass $someClass)
{
- while ($someClass !== null) {
+ while ($someClass instanceof SomeClass) {
// do something
}
}
}
```
< br >
2021-01-30 21:30:37 +01:00
## Visibility
### ChangeConstantVisibilityRector
Change visibility of constant from parent class.
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\Visibility\Rector\ClassConst\ChangeConstantVisibilityRector` ](../rules/Visibility/Rector/ClassConst/ChangeConstantVisibilityRector.php )
2021-01-30 21:30:37 +01:00
```diff
class FrameworkClass
{
protected const SOME_CONSTANT = 1;
}
class MyClass extends FrameworkClass
{
- public const SOME_CONSTANT = 1;
+ protected const SOME_CONSTANT = 1;
}
```
< br >
### ChangeMethodVisibilityRector
Change visibility of method from parent class.
:wrench: **configure it!**
2021-05-23 09:33:26 +00:00
- class: [`Rector\Visibility\Rector\ClassMethod\ChangeMethodVisibilityRector` ](../rules/Visibility/Rector/ClassMethod/ChangeMethodVisibilityRector.php )
2021-01-30 21:30:37 +01:00
```diff
class FrameworkClass
{
2021-07-22 18:40:24 +00:00
protected function someMethod()
2021-01-30 21:30:37 +01:00
{
}
}
class MyClass extends FrameworkClass
{
2021-07-22 18:40:24 +00:00
- public function someMethod()
+ protected function someMethod()
2021-01-30 21:30:37 +01:00
{
}
}
```
< br >
2022-04-10 00:31:45 +00:00
### ExplicitPublicClassMethodRector
Add explicit public method visibility.
- class: [`Rector\Visibility\Rector\ClassMethod\ExplicitPublicClassMethodRector` ](../rules/Visibility/Rector/ClassMethod/ExplicitPublicClassMethodRector.php )
```diff
class SomeClass
{
- function foo()
+ public function foo()
{
}
}
```
< br >