Skip to content

Commit f1a6537

Browse files
authored
Merge pull request #778 from meyerbaptiste/fix_cs
Fix CS & PHPDoc
2 parents e122925 + 6b7a62d commit f1a6537

20 files changed

+56
-54
lines changed

src/Api/IriConverterInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ public function getIriFromItem($item, int $referenceType = UrlGeneratorInterface
5050
* Gets the IRI associated with the given resource collection.
5151
*
5252
* @param string $resourceClass
53-
* @param string $referenceType
53+
* @param int $referenceType
5454
*
5555
* @throws InvalidArgumentException
5656
*

src/Bridge/Doctrine/Orm/Extension/EagerLoadingExtension.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ public function getMetadataProperties(string $resourceClass) : array
6666
*
6767
* @param QueryBuilder $queryBuilder
6868
* @param string $resourceClass
69+
* @param string $originAlias
70+
* @param string $relationAlias
6971
*/
7072
private function joinRelations(QueryBuilder $queryBuilder, string $resourceClass, string $originAlias = 'o', string &$relationAlias = 'a')
7173
{

src/Bridge/Doctrine/Orm/Extension/QueryCollectionExtensionInterface.php

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,10 @@
2323
interface QueryCollectionExtensionInterface
2424
{
2525
/**
26-
* @param QueryBuilder $queryBuilder
27-
* @param string $resourceClass
28-
* @param string $operationName
26+
* @param QueryBuilder $queryBuilder
27+
* @param QueryNameGeneratorInterface $queryNameGenerator
28+
* @param string $resourceClass
29+
* @param string|null $operationName
2930
*/
3031
public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null);
3132
}

src/Bridge/Doctrine/Orm/Extension/QueryItemExtensionInterface.php

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,11 @@
2323
interface QueryItemExtensionInterface
2424
{
2525
/**
26-
* @param QueryBuilder $queryBuilder
27-
* @param string $resourceClass
28-
* @param array $identifiers
29-
* @param string|null $operationName
26+
* @param QueryBuilder $queryBuilder
27+
* @param QueryNameGeneratorInterface $queryNameGenerator
28+
* @param string $resourceClass
29+
* @param array $identifiers
30+
* @param string|null $operationName
3031
*/
3132
public function applyToItem(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, array $identifiers, string $operationName = null);
3233
}

src/Bridge/Doctrine/Orm/Filter/AbstractFilter.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -270,10 +270,10 @@ private function getExistingJoin(QueryBuilder $queryBuilder, string $alias, stri
270270
/**
271271
* Adds a join to the queryBuilder if none exists.
272272
*
273-
* @param QueryBuilder $queryBuilder
274-
* @param QueryNameGenerator $queryNameGenerator
275-
* @param string $alias
276-
* @param string $association the association field
273+
* @param QueryBuilder $queryBuilder
274+
* @param QueryNameGeneratorInterface $queryNameGenerator
275+
* @param string $alias
276+
* @param string $association the association field
277277
*
278278
* @return string the new association alias
279279
*/

src/Bridge/Doctrine/Orm/Filter/SearchFilter.php

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -258,12 +258,13 @@ protected function filterProperty(string $property, $value, QueryBuilder $queryB
258258
/**
259259
* Adds where clause according to the strategy.
260260
*
261-
* @param string $strategy
262-
* @param QueryBuilder $queryBuilder
263-
* @param string $alias
264-
* @param string $field
265-
* @param string $value
266-
* @param bool $caseSensitive
261+
* @param string $strategy
262+
* @param QueryBuilder $queryBuilder
263+
* @param QueryNameGeneratorInterface $queryNameGenerator
264+
* @param string $alias
265+
* @param string $field
266+
* @param string $value
267+
* @param bool $caseSensitive
267268
*
268269
* @throws InvalidArgumentException If strategy does not exist
269270
*/

src/Bridge/Doctrine/Orm/ItemDataProvider.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,8 @@ private function addWhereForIdentifiers(array $identifiers, QueryBuilder $queryB
112112
* @param ObjectManager $manager
113113
* @param string $resourceClass
114114
*
115+
* @throws PropertyNotFoundException
116+
*
115117
* @return array
116118
*/
117119
private function normalizeIdentifiers($id, ObjectManager $manager, string $resourceClass) : array

src/Bridge/Doctrine/Orm/Util/QueryNameGenerator.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
* @author Teoh Han Hui <[email protected]>
1818
* @author Vincent Chalamon <[email protected]>
1919
* @author Amrouche Hamza <[email protected]>
20-
2120
*/
2221
final class QueryNameGenerator implements QueryNameGeneratorInterface
2322
{

src/Serializer/AbstractItemNormalizer.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,7 @@ protected function setAttributeValue($object, $attribute, $value, $format = null
192192
*
193193
* @param string $attribute
194194
* @param Type $type
195+
* @param mixed $value
195196
* @param string|null $format
196197
*
197198
* @throws InvalidArgumentException

tests/Bridge/Doctrine/Orm/Extension/EagerLoadingExtensionTest.php

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
1919
use ApiPlatform\Core\Metadata\Property\PropertyNameCollection;
2020
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
21-
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyRelated;
21+
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\RelatedDummy;
2222
use Doctrine\ORM\EntityManager;
2323
use Doctrine\ORM\Mapping\ClassMetadata;
2424
use Doctrine\ORM\QueryBuilder;
@@ -34,7 +34,7 @@ public function testApplyToCollection()
3434

3535
$relatedNameCollection = new PropertyNameCollection(['id', 'name', 'notindatabase', 'notreadable']);
3636

37-
$propertyNameCollectionFactoryProphecy->create(DummyRelated::class)->willReturn($relatedNameCollection)->shouldBeCalled();
37+
$propertyNameCollectionFactoryProphecy->create(RelatedDummy::class)->willReturn($relatedNameCollection)->shouldBeCalled();
3838

3939
$propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
4040
$relationPropertyMetadata = new PropertyMetadata();
@@ -52,18 +52,18 @@ public function testApplyToCollection()
5252
$notReadablePropertyMetadata = new PropertyMetadata();
5353
$notReadablePropertyMetadata = $notReadablePropertyMetadata->withReadable(false);
5454

55-
$propertyMetadataFactoryProphecy->create(DummyRelated::class, 'id')->willReturn($idPropertyMetadata)->shouldBeCalled();
56-
$propertyMetadataFactoryProphecy->create(DummyRelated::class, 'name')->willReturn($namePropertyMetadata)->shouldBeCalled();
57-
$propertyMetadataFactoryProphecy->create(DummyRelated::class, 'notindatabase')->willReturn($notInDatabasePropertyMetadata)->shouldBeCalled();
58-
$propertyMetadataFactoryProphecy->create(DummyRelated::class, 'notreadable')->willReturn($notReadablePropertyMetadata)->shouldBeCalled();
55+
$propertyMetadataFactoryProphecy->create(RelatedDummy::class, 'id')->willReturn($idPropertyMetadata)->shouldBeCalled();
56+
$propertyMetadataFactoryProphecy->create(RelatedDummy::class, 'name')->willReturn($namePropertyMetadata)->shouldBeCalled();
57+
$propertyMetadataFactoryProphecy->create(RelatedDummy::class, 'notindatabase')->willReturn($notInDatabasePropertyMetadata)->shouldBeCalled();
58+
$propertyMetadataFactoryProphecy->create(RelatedDummy::class, 'notreadable')->willReturn($notReadablePropertyMetadata)->shouldBeCalled();
5959

6060
$queryBuilderProphecy = $this->prophesize(QueryBuilder::class);
6161

6262
$classMetadataProphecy = $this->prophesize(ClassMetadata::class);
6363
$classMetadataProphecy->getAssociationNames()->shouldBeCalled()->willReturn([0 => 'relatedDummy', 'relatedDummy2']);
6464
$classMetadataProphecy->associationMappings = [
65-
'relatedDummy' => ['fetch' => 3, 'joinColumns' => [['nullable' => true]], 'targetEntity' => DummyRelated::class],
66-
'relatedDummy2' => ['fetch' => 3, 'joinColumns' => [['nullable' => false]], 'targetEntity' => DummyRelated::class],
65+
'relatedDummy' => ['fetch' => 3, 'joinColumns' => [['nullable' => true]], 'targetEntity' => RelatedDummy::class],
66+
'relatedDummy2' => ['fetch' => 3, 'joinColumns' => [['nullable' => false]], 'targetEntity' => RelatedDummy::class],
6767
];
6868

6969
$relatedClassMetadataProphecy = $this->prophesize(ClassMetadata::class);
@@ -78,14 +78,14 @@ public function testApplyToCollection()
7878

7979
$emProphecy = $this->prophesize(EntityManager::class);
8080
$emProphecy->getClassMetadata(Dummy::class)->shouldBeCalled()->willReturn($classMetadataProphecy->reveal());
81-
$emProphecy->getClassMetadata(DummyRelated::class)->shouldBeCalled()->willReturn($relatedClassMetadataProphecy->reveal());
81+
$emProphecy->getClassMetadata(RelatedDummy::class)->shouldBeCalled()->willReturn($relatedClassMetadataProphecy->reveal());
8282

8383
$queryBuilderProphecy->leftJoin('o.relatedDummy', 'a0')->shouldBeCalled(1);
8484
$queryBuilderProphecy->innerJoin('o.relatedDummy2', 'a11')->shouldBeCalled(1);
8585
$queryBuilderProphecy->addSelect('partial a0.{id,name}')->shouldBeCalled(1);
8686
$queryBuilderProphecy->addSelect('partial a11.{id,name}')->shouldBeCalled(1);
8787

88-
$em = $queryBuilderProphecy->getEntityManager()->shouldBeCalled(2)->willReturn($emProphecy->reveal());
88+
$queryBuilderProphecy->getEntityManager()->shouldBeCalled(2)->willReturn($emProphecy->reveal());
8989

9090
$queryBuilder = $queryBuilderProphecy->reveal();
9191
$orderExtensionTest = new EagerLoadingExtension($propertyNameCollectionFactoryProphecy->reveal(), $propertyMetadataFactoryProphecy->reveal());
@@ -98,7 +98,7 @@ public function testApplyToItem()
9898

9999
$relatedNameCollection = new PropertyNameCollection(['id', 'name', 'notindatabase', 'notreadable']);
100100

101-
$propertyNameCollectionFactoryProphecy->create(DummyRelated::class)->willReturn($relatedNameCollection)->shouldBeCalled();
101+
$propertyNameCollectionFactoryProphecy->create(RelatedDummy::class)->willReturn($relatedNameCollection)->shouldBeCalled();
102102

103103
$propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
104104
$relationPropertyMetadata = new PropertyMetadata();
@@ -118,20 +118,20 @@ public function testApplyToItem()
118118
$notReadablePropertyMetadata = new PropertyMetadata();
119119
$notReadablePropertyMetadata = $notReadablePropertyMetadata->withReadable(false);
120120

121-
$propertyMetadataFactoryProphecy->create(DummyRelated::class, 'id')->willReturn($idPropertyMetadata)->shouldBeCalled();
122-
$propertyMetadataFactoryProphecy->create(DummyRelated::class, 'name')->willReturn($namePropertyMetadata)->shouldBeCalled();
123-
$propertyMetadataFactoryProphecy->create(DummyRelated::class, 'notindatabase')->willReturn($notInDatabasePropertyMetadata)->shouldBeCalled();
124-
$propertyMetadataFactoryProphecy->create(DummyRelated::class, 'notreadable')->willReturn($notReadablePropertyMetadata)->shouldBeCalled();
121+
$propertyMetadataFactoryProphecy->create(RelatedDummy::class, 'id')->willReturn($idPropertyMetadata)->shouldBeCalled();
122+
$propertyMetadataFactoryProphecy->create(RelatedDummy::class, 'name')->willReturn($namePropertyMetadata)->shouldBeCalled();
123+
$propertyMetadataFactoryProphecy->create(RelatedDummy::class, 'notindatabase')->willReturn($notInDatabasePropertyMetadata)->shouldBeCalled();
124+
$propertyMetadataFactoryProphecy->create(RelatedDummy::class, 'notreadable')->willReturn($notReadablePropertyMetadata)->shouldBeCalled();
125125

126126
$queryBuilderProphecy = $this->prophesize(QueryBuilder::class);
127127

128128
$classMetadataProphecy = $this->prophesize(ClassMetadata::class);
129129
$classMetadataProphecy->getAssociationNames()->shouldBeCalled()->willReturn([0 => 'relatedDummy', 'relatedDummy2', 'relatedDummy3', 'relatedDummy4']);
130130
$classMetadataProphecy->associationMappings = [
131-
'relatedDummy' => ['fetch' => 3, 'joinColumns' => [['nullable' => true]], 'targetEntity' => DummyRelated::class],
132-
'relatedDummy2' => ['fetch' => 3, 'joinColumns' => [['nullable' => false]], 'targetEntity' => DummyRelated::class],
133-
'relatedDummy3' => ['fetch' => 3, 'joinTable' => ['joinColumns' => [['nullable' => false]]], 'targetEntity' => DummyRelated::class],
134-
'relatedDummy4' => ['fetch' => 3, 'targetEntity' => DummyRelated::class],
131+
'relatedDummy' => ['fetch' => 3, 'joinColumns' => [['nullable' => true]], 'targetEntity' => RelatedDummy::class],
132+
'relatedDummy2' => ['fetch' => 3, 'joinColumns' => [['nullable' => false]], 'targetEntity' => RelatedDummy::class],
133+
'relatedDummy3' => ['fetch' => 3, 'joinTable' => ['joinColumns' => [['nullable' => false]]], 'targetEntity' => RelatedDummy::class],
134+
'relatedDummy4' => ['fetch' => 3, 'targetEntity' => RelatedDummy::class],
135135
];
136136

137137
$relatedClassMetadataProphecy = $this->prophesize(ClassMetadata::class);
@@ -146,7 +146,7 @@ public function testApplyToItem()
146146

147147
$emProphecy = $this->prophesize(EntityManager::class);
148148
$emProphecy->getClassMetadata(Dummy::class)->shouldBeCalled()->willReturn($classMetadataProphecy->reveal());
149-
$emProphecy->getClassMetadata(DummyRelated::class)->shouldBeCalled()->willReturn($relatedClassMetadataProphecy->reveal());
149+
$emProphecy->getClassMetadata(RelatedDummy::class)->shouldBeCalled()->willReturn($relatedClassMetadataProphecy->reveal());
150150

151151
$queryBuilderProphecy->leftJoin('o.relatedDummy', 'a0')->shouldBeCalled(1);
152152
$queryBuilderProphecy->innerJoin('o.relatedDummy2', 'a11')->shouldBeCalled(1);
@@ -157,7 +157,7 @@ public function testApplyToItem()
157157
$queryBuilderProphecy->addSelect('partial a122.{id,name}')->shouldBeCalled(1);
158158
$queryBuilderProphecy->addSelect('partial a1233.{id,name}')->shouldBeCalled(1);
159159

160-
$em = $queryBuilderProphecy->getEntityManager()->shouldBeCalled(2)->willReturn($emProphecy->reveal());
160+
$queryBuilderProphecy->getEntityManager()->shouldBeCalled(2)->willReturn($emProphecy->reveal());
161161

162162
$queryBuilder = $queryBuilderProphecy->reveal();
163163
$orderExtensionTest = new EagerLoadingExtension($propertyNameCollectionFactoryProphecy->reveal(), $propertyMetadataFactoryProphecy->reveal());

0 commit comments

Comments
 (0)