Add native type to private properties and final classes #2666
Conversation
fe5b616 to
a87f55a
Compare
| @@ -64,23 +56,6 @@ public function __construct(DocumentManager $dm, UnitOfWork $uow) | |||
| { | |||
| $this->dm = $dm; | |||
| $this->uow = $uow; | |||
|
|
|||
| $this->defaultPrimer = static function (DocumentManager $dm, ClassMetadata $class, array $ids, array $hints): void { | |||
There was a problem hiding this comment.
Moved to private class method.
| @@ -124,7 +99,7 @@ public function primeReferences(ClassMetadata $class, $documents, string $fieldN | |||
| throw new LogicException(sprintf('Field "%s" is an identifier reference without a target document class in class "%s"', $fieldName, $class->name)); | |||
| } | |||
|
|
|||
| $primer = $primer ?: $this->defaultPrimer; | |||
| $primer = $primer ?: $this->defaultPrimer(...); | |||
There was a problem hiding this comment.
First-class closure available since PHP 8.1
| @@ -32,8 +32,7 @@ | |||
| */ | |||
| class Fill extends Stage | |||
| { | |||
| /** @var mixed|Expr|null */ | |||
| private $partitionBy = null; | |||
| private mixed $partitionBy = null; | |||
There was a problem hiding this comment.
Dunno how much value it's bringing IRL, but knowing there could be Expr makes one remember about it
There was a problem hiding this comment.
This is reported by phpcs.
FILE: lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Fill.php
-----------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-----------------------------------------------------------------------------------
35 | ERROR | [x] Property
| | \Doctrine\ODM\MongoDB\Aggregation\Stage\Fill::$partitionBy has
| | useless @var annotation.
-----------------------------------------------------------------------------------
I could try to restrict the types, but I would have to accept object which also overlaps Expr.
This is a private property, the setter keeps the full documented types:
mongodb-odm/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Fill.php
Lines 53 to 54 in 99b4183
| @@ -24,8 +24,8 @@ | |||
| */ | |||
| final class HydratingIterator implements Iterator | |||
| { | |||
| /** @var Generator<mixed, array<string, mixed>>|null */ | |||
| private $iterator; | |||
| /** @var Generator<mixed, array<string, mixed>> */ | |||
There was a problem hiding this comment.
Good catch. I tried to make it non-nullable and unset it in __destruct, but that didn't work as expected.
| * @param mixed[] $ids | ||
| * @param array<int, mixed> $hints | ||
| */ | ||
| private function defaultPrimer(DocumentManager $dm, ClassMetadata $class, array $ids, array $hints): void |
There was a problem hiding this comment.
We can, so we are sure we don't access the ReferencePrimer instance.
d2bf406 to
e21c473
Compare
| */ | ||
| private $dm; | ||
| private ?DocumentManager $dm = null; |
There was a problem hiding this comment.
Not sure how exactly this property is used in this code, but would it make more sense to rely on the TypeError if it wasn't properly initialised before access?
There was a problem hiding this comment.
Removed the nullable, it seems to work.
| */ | ||
| private $uow; | ||
| private ?UnitOfWork $uow = null; |
There was a problem hiding this comment.
Same question as with the dm property above
4d9740a to
4fd4cf1
Compare
* 2.9.x: (24 commits) Fix typo in code example (#2670) Label PRs about GH actions with "CI" (#2632) Review basic mapping (#2668) Fix wording (#2667) Add native type to private properties and final classes (#2666) Review and add tests on `ResolveTargetDocumentListener` (#2660) Remove soft-delete-cookbook (#2657) doc: Remove wakeup and clone cookbook (#2663) Modernize generated code for Hydrators (#2665) Add tests for introduction (#2664) doc: Review mapping ORM and ODM cookbook (#2658) doc: Review cookbook on blending ORM and ODM (#2656) doc: Review and test validation cookbook (#2662) Update custom mapping example (#2654) doc: Review Simple Search Engine Cookbook (#2659) doc: Add cookbook about embedding referenced documents using $lookup (#2655) doc: Add type to properties (#2652) doc: Review custom collections and repository docs (#2653) doc: Review Getting Started (#2650) Move annotations-reference to attributes-reference (#2651) ...
Summary
Some private properties were not typed, mainly because
mixedor union types were not available in previous PHP version.