Views

[alcaeus]

Q	A
Type	feature
BC Break	no
Fixed issues	Fixes #1925.

Summary

As per the ticket, this is an implementation of MongoDB views in ODM. Views are treated as a separate mapped object class, similar to files, documents, and query results. Views cannot be proxied (for now), and their repository must implement a specific ViewRepository interface. Thus, a view cannot be mapped without a custom repository.

The ViewRepository interface defines a single method:

public function createViewAggregation(Builder $builder) : void;

This method receives an aggregation builder instance based on the document specified in the viewOn mapping attribute. This was done as the view needs to be static, so any dynamic changes (e.g. by choosing a different class to base the view on) must be avoided. The aggregation builder instance is then used to build the aggregation pipeline that defines the view. Exposing a builder instance will allow for more flexibility down the line, as we could leverage this builder to optimise queries, e.g. if there is an inverse reference pointing to a view).

As for always requiring a custom repository, I had considered letting the mapped class define the pipeline, but I thought that the repository was a better fit than a static method on the entity (potentially with a custom name).

This PR covers:

• Annotation and XML mappings for views
• Schema manager logic to create and drop views
• Refactoring AbstractRepositoryFactory to throw exceptions when trying to get the repository for an invalid class (e.g. an embedded document)
• Refactoring the mapping driver test to use the document manager created: this allows us to better test mappings
• Documentation
• Allow using views as targetDocument for references, including proxy handling

[malarzm]

Looking good!

[malarzm]

Isn't this reported by PHPStan as unreachable code?

[alcaeus]

Nope 🤔

[malarzm]

Could you remove it? :)

[malarzm]

Build is failing tho ;)

EDIT: seems like usual stuff, restarted failed builds for you