Add documentation for ImportFullyQualifiedNamesRector new '$shouldImportRootNamespaceClasses' argument.

This commit is contained in:
Dorian Villet 2019-10-04 16:59:42 +02:00
parent 7e16b2f477
commit 7c9f4a33cd
3 changed files with 107 additions and 4 deletions

View File

@ -1,4 +1,4 @@
# All 367 Rectors Overview
# All 369 Rectors Overview
- [Projects](#projects)
- [General](#general)
@ -1246,6 +1246,32 @@ Import fully qualified names to use statements
}
```
```yaml
services:
Rector\CodingStyle\Rector\Namespace_\ImportFullyQualifiedNamesRector:
$shouldImportRootNamespaceClasses: false
```
```diff
+use SomeAnother\AnotherClass;
+
class SomeClass
{
public function create()
{
- return SomeAnother\AnotherClass;
+ return AnotherClass;
}
public function createDate()
{
return new \DateTime(); // this remains untouched
}
}
```
<br>
### `MakeInheritedMethodVisibilitySameAsParentRector`
@ -1369,7 +1395,7 @@ services:
- class: `Rector\CodingStyle\Rector\Use_\RemoveUnusedAliasRector`
Removes unused use aliases
Removes unused use aliases. Keep annotation aliases like "Doctrine\ORM\Mapping as ORM" to keep convention format
```diff
-use Symfony\Kernel as BaseKernel;
@ -1532,6 +1558,25 @@ Prefer quote that not inside the string
<br>
### `UseIncrementAssignRector`
- class: `Rector\CodingStyle\Rector\Assign\UseIncrementAssignRector`
Use ++ increment instead of $var += 1.
```diff
class SomeClass
{
public function run()
{
- $style += 1;
+ ++$style
}
}
```
<br>
### `VarConstantCommentRector`
- class: `Rector\CodingStyle\Rector\ClassConst\VarConstantCommentRector`
@ -1983,6 +2028,26 @@ Removes method that set values that are never used
<br>
### `RemoveUnreachableStatementRector`
- class: `Rector\DeadCode\Rector\Stmt\RemoveUnreachableStatementRector`
Remove unreachable statements
```diff
class SomeClass
{
public function run()
{
return 5;
-
- $removeMe = 10;
}
}
```
<br>
### `RemoveUnusedDoctrineEntityMethodAndPropertyRector`
- class: `Rector\DeadCode\Rector\Class_\RemoveUnusedDoctrineEntityMethodAndPropertyRector`
@ -3869,7 +3934,7 @@ Remove 0 from break and continue
- class: `Rector\Php55\Rector\FuncCall\PregReplaceEModifierRector`
The /e modifier is no longer supported, use preg_replace_callback instead
The /e modifier is no longer supported, use preg_replace_callback instead
```diff
class SomeClass

View File

@ -917,7 +917,7 @@ if (true) {
```php
?>
<strong>feel</strong><?php
<strong>feel</strong><?php
```
<br>

View File

@ -7,6 +7,7 @@ use PhpParser\Node\Name;
use Rector\CodingStyle\Node\NameImporter;
use Rector\Rector\AbstractRector;
use Rector\RectorDefinition\CodeSample;
use Rector\RectorDefinition\ConfiguredCodeSample;
use Rector\RectorDefinition\RectorDefinition;
/**
@ -65,6 +66,43 @@ class SomeClass
}
PHP
),
new ConfiguredCodeSample(
<<<'PHP'
class SomeClass
{
public function create()
{
return SomeAnother\AnotherClass;
}
public function createDate()
{
return new \DateTime(); // this remains untouched
}
}
PHP
,
<<<'PHP'
use SomeAnother\AnotherClass;
class SomeClass
{
public function create()
{
return AnotherClass;
}
public function createDate()
{
return new \DateTime(); // this remains untouched
}
}
PHP
,
[
'$shouldImportRootNamespaceClasses' => false,
]
),
]);
}