[Reverse relation] Support configuration of visible fields

[BlackbitDevs]

For (advanced) many-to-many object relations you can configure the fields to be shown for the relation field grid in the editing panel.
This PR adds the same for reverse relations:

[github-actions]

Review Checklist

• Target branch (10.5 for bug fixes, others 11.x)
• Tests (if it's testable code, there should be a test for it - get help)
• Docs (every functionality needs to be documented, see here)
• Migration incl. install.sql (e.g. if the database schema changes, ...)
• Upgrade notes (deprecations, important information, migration hints, ...)
• Label
• Milestone

[Corepex]

@BlackbitDevs could you please resolve the conflicts? :) thanks

[BlackbitDevs]

@Corepex Done.

[Corepex]

@BlackbitDevs, could you also please merge the 11.x branch into your branch again - this should fix the test errors - thanks

[BlackbitDevs]

@Corepex Done.

[Corepex]

@BlackbitDevs could you please fix the tests 😺

[brusch]

@BlackbitDevs 🏓😉 Just a quick reminder - Thanks!

[BlackbitDevs]

@Corepex, @brusch Done.

[Corepex]

@BlackbitDevs, thanks for this really cool PR. I really like the idea of customizing the columns of the reverse relation.

One weird thing I found is that if I save the class multiple times (10 - 20 times), I sometimes get the following error: Typed property Pimcore\Model\DataObject\ClassDefinition\Data\ReverseObjectRelation::$ownerClassName must not be accessed before initialization

Seems like this is called in ReverseObjectRelation::getClasses() and throws the error at ReverseObjectRelation::getOwnerClassId -> ($class = DataObject\ClassDefinition::getByName($this->ownerClassName))

[BlackbitDevs]

@Corepex Is fixed. It was caused by wrong property type in

pimcore/models/DataObject/ClassDefinition/Data/ReverseObjectRelation.php

Line 43 in 46c8fe5

public string $ownerClassName;

When this shall be initialized with null (what it does when no default value is given and the property does not get set in the __constructor) the type has to be ?string. For more information see https://madewithlove.com/blog/software-engineering/typed-property-must-not-be-accessed-before-initialization/#uninitialized-fields

[blankse]

We should init it with null otherwise it will occure a error when you read it without writing

[Corepex]

@BlackbitDevs is that PR ready for testing again?

[BlackbitDevs]

@Corepex Yes

[Corepex]

@BlackbitDevs now i get another error when saving the class multiple times. The following error message gets displayed: Pimcore\Model\DataObject\ClassDefinition::getByName(): Argument #1 ($name) must be of type string, null given, called in /var/www/html/dev/pimcore/pimcore/models/DataObject/ClassDefinition/Data/ReverseObjectRelation.php on line 99 (see screenshot).

It seems that the owner_class field gets cleared for some reason after saving ...

[Corepex]

@BlackbitDevs friendly reminder ⏰ 🍭

[BlackbitDevs]

Ok, wrapped another if condition. Can you please try again, @Corepex?

[Corepex]

It seems that the owner_class field gets cleared for some reason after saving ...

@BlackbitDevs, this error doesn't seem to be fixed - the owner_class field is still getting cleared out sometimes.

[Corepex]

@BlackbitDevs final reminder. ⏰
Please respond latest by 24.03 - otherwise, I will close the ticket due to inactivity.

[BlackbitDevs]

@Corepex Please check again. I cannot reproduce the issue. I clicked multiple times on save - with set owner class as well as without. Everything works as expected.

[Corepex]

@BlackbitDevs I just set up a new pimcore 11.x instance. The owner_class issue seems to be fixed now - good job 🎉

Sadly I found some new bugs that need to be fixed.

1. Empty Columns
   If I add a new entry to the relation it seems that some of the columns are empty ... maybe you could find a way to load the column data when adding the object to the relation.

2. Missing scrollbar
   I also tested the option to add an image field to the grid.
   There we should add a scrollbar to the relation field because it only shows some (not all) entries.

I used the Category object from the demo and added the following fields:

• fullpath
• key
• published
• modificationDate
• filename
• name
• location
• (genericImages)

[BlackbitDevs]

@Corepex Fixed loading the visible field data after adding via drag & drop or search window.

The height issue was caused by

pimcore/bundles/AdminBundle/public/js/pimcore/object/tags/manyToManyObjectRelation.js

Lines 963 to 967 in 24d8ca4

	if (nicePathRequested) {
	window.setTimeout(function () {
	this.component.getView().refresh();
	}.bind(this), 500);
	}

This was introduced in #5378 (after I suggested a similar solution in #4337)
For fields which do not use optimizedAdminLoading, the field data already gets fetched by loadObjectData, for example in

pimcore/bundles/AdminBundle/public/js/pimcore/object/tags/manyToManyObjectRelation.js

Line 618 in 24d8ca4

toBeRequested.add(this.loadObjectData(initData, this.visibleFields));

For those fields fieldsstays empty in

pimcore/bundles/AdminBundle/public/js/pimcore/object/tags/manyToManyObjectRelation.js

Lines 921 to 934 in 24d8ca4

	var fields = [];
	var context = this.getContext();
	var loadEditModeData = false;
	if(isInitialLoad && this.fieldConfig.optimizedAdminLoading && context['containerType'] == 'object') {
	loadEditModeData = true;
	if(this.visibleFields) {
	fields = fields.concat(this.visibleFields);
	}
	if(this.fieldConfig.columnKeys) {
	fields = fields.concat(this.fieldConfig.columnKeys);
	}
	}

and thus

pimcore/bundles/AdminBundle/public/js/pimcore/object/tags/manyToManyObjectRelation.js

Line 937 in 24d8ca4

var nicePathRequested = pimcore.helpers.requestNicePathData(

returns nicePathRequested = undefined
and thus we did not get to

pimcore/bundles/AdminBundle/public/js/pimcore/object/tags/manyToManyObjectRelation.js

Lines 963 to 968 in 24d8ca4

	if (nicePathRequested) {
	window.setTimeout(function () {
	this.component.getView().refresh();
	}.bind(this), 500);
	}
	},

And for this reason the height was not adjusted. The same problem existed for normal many-to-many object relations with a visible image field: After adding something via drag & drop, the image is cut off.

Now it should work.

[robertSt7]

@BlackbitDevs Could you please resolve the conflicts? Thanks

[BlackbitDevs]

@robertSt7 As the JS files are now part of https://github.com/pimcore/admin-ui-classic-bundle I have splitted this PR into 2. This one contains the core changes and pimcore/admin-ui-classic-bundle#290 contains the UI changes.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
47 Code Smells

No Coverage information
2.1% Duplication

[dvesh3]

@robertSt7 ready for merge?

[robertSt7]

@BlackbitDevs Thanks for the PR