Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merge AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector to single rule #331

Merged
merged 1 commit into from
Jul 25, 2024
Merged

Merge AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector to single rule #331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 6 additions & 29 deletions docs/rector_rules_overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,49 +1,26 @@
# 19 Rules Overview
# 18 Rules Overview

## AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector

Adds `@return` PHPDoc type to Collection property getter by *ToMany annotation
Adds `@return` PHPDoc type to Collection property getter by *ToMany annotation/attribute

- class: [`Rector\Doctrine\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector`](../rules/CodeQuality/Rector/Class_/AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector.php)

```diff
-use App\Entity\Training;
-
/**
* @ORM\Entity
*/
final class Trainer
{
/**
* @ORM\OneToMany(targetEntity=Training::class, mappedBy="trainer")
* @ORM\OneToMany(targetEntity=Training::class)
*/
private $trainings;

+ /**
+ * @return \Doctrine\Common\Collections\Collection<int, \Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source>
+ */
public function getTrainings()
{
return $this->trainings;
}
}
```

<br>

## AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector

Adds `@return` PHPDoc type to Collection property getter by *ToMany attribute

- class: [`Rector\Doctrine\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector`](../rules/CodeQuality/Rector/Class_/AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector.php)

```diff
#[ORM\Entity]
final class Trainer
{
#[ORM\OneToMany(targetEntity:Training::class, mappedBy:"trainer")]
private $trainings;

+ /**
+ * @return \Doctrine\Common\Collections\Collection<int, \Rector\Doctrine\Tests\CodeQuality\Rector\Property\ImproveDoctrineCollectionDocTypeInEntityRector\Source\Training>
+ * @return \Doctrine\Common\Collections\Collection<int, \App\Entity\Training>
+ */
public function getTrainings()
{
Expand Down
21 changes: 21 additions & 0 deletions ...tyGetterByToManyAnnotationRector/Fixture/ManyToMany/attribute_getter_with_return_type.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?php

namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Fixture\ManyToMany;

use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training;

#[ORM\Entity]
final class Trainer
{
#[ORM\ManyToMany(targetEntity:Training::class, mappedBy:"trainer")]
private $trainings;

public function getTrainings(): Collection
{
return $this->trainings;
}
}

?>
10 changes: 5 additions & 5 deletions ...anyToMany/getter_with_return_type.php.inc → ...attribute_getter_with_return_type.php.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?php

namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Fixture\ManyToMany;
namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Fixture\ManyToMany;

use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Source\Training;
use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training;

#[ORM\Entity]
final class Trainer
Expand All @@ -22,11 +22,11 @@ final class Trainer
-----
<?php

namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Fixture\ManyToMany;
namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Fixture\ManyToMany;

use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Source\Training;
use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training;

#[ORM\Entity]
final class Trainer
Expand All @@ -35,7 +35,7 @@ final class Trainer
private $trainings;

/**
* @return \Doctrine\Common\Collections\Collection<int, \Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Source\Training>
* @return \Doctrine\Common\Collections\Collection<int, \Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training>
*/
public function getTrainings(): Collection
{
Expand Down
14 changes: 7 additions & 7 deletions ...OneToMany/getter_with_return_type.php.inc → ...attribute_getter_with_return_type.php.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<?php

namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Fixture\OneToMany;
namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Fixture\OneToMany;

use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Source\Training;
use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training;

#[ORM\Entity]
final class Trainer
final class AttributeGetterWithReturnType
{
#[ORM\OneToMany(targetEntity:Training::class, mappedBy:"trainer")]
private $trainings;
Expand All @@ -22,20 +22,20 @@ final class Trainer
-----
<?php

namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Fixture\OneToMany;
namespace Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Fixture\OneToMany;

use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Source\Training;
use Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training;

#[ORM\Entity]
final class Trainer
final class AttributeGetterWithReturnType
{
#[ORM\OneToMany(targetEntity:Training::class, mappedBy:"trainer")]
private $trainings;

/**
* @return \Doctrine\Common\Collections\Collection<int, \Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRector\Source\Training>
* @return \Doctrine\Common\Collections\Collection<int, \Rector\Doctrine\Tests\CodeQuality\Rector\Class_\AddReturnDocBlockToCollectionPropertyGetterByToManyAnnotationRector\Source\Training>
*/
public function getTrainings(): Collection
{
Expand Down
28 changes: 0 additions & 28 deletions ...ttributeRector/AddReturnDocBlockToCollectionPropertyGetterByToManyAttributeRectorTest.php
View file
Open in desktop

This file was deleted.

41 changes: 0 additions & 41 deletions ...GetterByToManyAttributeRector/Fixture/OneToMany/association_with_no_target_entity.php.inc
View file
Open in desktop

This file was deleted.

46 changes: 0 additions & 46 deletions ...ropertyGetterByToManyAttributeRector/Fixture/OneToMany/getter_without_return_type.php.inc
View file
Open in desktop

This file was deleted.

57 changes: 0 additions & 57 deletions ...ByToManyAttributeRector/Fixture/OneToMany/multiple_returned_collection_properties.php.inc
View file
Open in desktop

This file was deleted.

39 changes: 0 additions & 39 deletions ...tionPropertyGetterByToManyAttributeRector/Fixture/OneToMany/no_collection_methods.php.inc
View file
Open in desktop

This file was deleted.

Loading
Loading