doc: Review custom collections and repository docs #2653
Conversation
GromNaN
commented
Jun 24, 2024
GromNaN
commented
| Q | A |
|---|---|
| Type | doc |
| BC Break | no |
| Fixed issues | - |
| @@ -3,9 +3,6 @@ | |||
| Custom Collections | |||
| ================== | |||
|
|
|||
| .. note:: | |||
| This feature was introduced in version 1.1 | |||
There was a problem hiding this comment.
We are v2.9, no need to mention such an old version.
| public function createFrom(array $elements): static | ||
| { | ||
| return new static($this->eventDispatcher, $elements); | ||
| } |
There was a problem hiding this comment.
Implementing this method was missing from the doc.
| class SectionCollection extend ArrayCollection | ||
| { | ||
| public function __construct( | ||
| private EventDispatcherInterface $eventDispatcher, |
There was a problem hiding this comment.
The doc doesn't say how to inject the dependency when creating a new SectionCollection.
I think, it must be done when creating the Application instance:
#[Document]
class Application
{
public function __construct(
#[EmbedMany(
collectionClass: SectionCollection::class,
targetDocument: Section::class,
)]
public Collection $sections;
) {}
}$application = new Application(
sections: new SectionCollection($eventDispatcher),
);Or keeping the SectionCollection class internal:
#[Document]
class Application
{
#[EmbedMany(
collectionClass: SectionCollection::class,
targetDocument: Section::class,
)]
public Collection $sections;
public function __construct(
EventDispatcherInterface $eventDispatcher,
) {
$this->sections = new SectionCollection($eventDispatcher);
}
}$application = new Application($eventDispatcher);
There was a problem hiding this comment.
Yeah, instantiating the class for new documents is totally on user and was left as an exercise ;) Feel free to propose these 2 ways! Although in first one you should pass a SectionCollection to Application's ctor
There was a problem hiding this comment.
I've chosen to keep only the first example. The 2nd is just a syntax variation. Since it's an advanced example, it's intended for developers who will be able to find the alternative if needed.
| @@ -41,11 +40,6 @@ owning document's class. | |||
| Custom Collection Classes | |||
| ------------------------- | |||
|
|
|||
| .. note:: | |||
| You may want to check `malarzm/collections <https://github.com/malarzm/collections>`_ | |||
There was a problem hiding this comment.
This package is not compatible with doctrine/collection v2. Consider restoring a link once @malarzm's package is updated.
There was a problem hiding this comment.
No need to remove just yet, the package will be compatible soon ™️ :D
There was a problem hiding this comment.
On a more serious note, feel free ;)
| return match ($collectionClass) { | ||
| SectionCollection::class => new SectionCollection([], $this->eventDispatcher), | ||
| default => new $collectionClass(), | ||
| }; |
There was a problem hiding this comment.
The match operator is perfect for this use-case.
GromNaN
changed the title
| @@ -41,11 +40,6 @@ owning document's class. | |||
| Custom Collection Classes | |||
| ------------------------- | |||
|
|
|||
| .. note:: | |||
| You may want to check `malarzm/collections <https://github.com/malarzm/collections>`_ | |||
There was a problem hiding this comment.
No need to remove just yet, the package will be compatible soon ™️ :D
| class SectionCollection extend ArrayCollection | ||
| { | ||
| public function __construct( | ||
| private EventDispatcherInterface $eventDispatcher, |
There was a problem hiding this comment.
Yeah, instantiating the class for new documents is totally on user and was left as an exercise ;) Feel free to propose these 2 ways! Although in first one you should pass a SectionCollection to Application's ctor
| @@ -41,11 +40,6 @@ owning document's class. | |||
| Custom Collection Classes | |||
| ------------------------- | |||
|
|
|||
| .. note:: | |||
| You may want to check `malarzm/collections <https://github.com/malarzm/collections>`_ | |||
There was a problem hiding this comment.
On a more serious note, feel free ;)
* 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) ...
