FEATURE: Custom label for auto created child nodes #530

dfeyer · 2016-05-19T14:31:32Z

Resolves: #2276

This change add a node type configuration to generate a custom node label
for auto created child nodes:

'Neos.Neos.NodeTypes:Page':
  superTypes:
    'Neos.Neos:Document': TRUE
  childNodes:
    main:
      label: 'Main Content Collection'
      type: 'Neos.Neos:ContentCollection'

This allow to have a less technical content tree. This change include the
schema validation and default label for default node types.

The label can be a string or an EEL expression. Inside the
expression you can access the parent node in the variable parentNode.

mention-bot · 2016-05-19T14:31:35Z

By analyzing the blame information on this pull request, we identified @radmiraal, @skurfuerst and @aertmann to be potential reviewers

dfeyer · 2016-05-19T14:34:53Z

Pretty useful for ContentCollection to replace "Content Collection (footer)", by something more human readable like "Document Footer". Also useful with complex node type with multiple child node, like a Staff, with multiple PostalAddress and ContactInformation, ...)

kitsunet · 2016-05-20T00:14:00Z

TYPO3.TYPO3CR/Classes/TYPO3/TYPO3CR/Domain/Model/ExpressionBasedNodeLabelGenerator.php

@@ -71,13 +74,27 @@ public function initializeObject()
     */
    public function getLabel(NodeInterface $node, $crop = true)
    {
-        $label = \TYPO3\Eel\Utility::evaluateEelExpression($this->getExpression(), $this->eelEvaluator, array('node' => $node), $this->defaultContextConfiguration);
+        $label = null;
+        if ($node->getNodeType()->isOfType('TYPO3.Neos:ContentCollection') && $node->isAutoCreated()) {


This is a no-go as it introduces a semi dependency of Neos in CR. If we want to introduce this kind of feature it must work for all node types.
I could accept that and I can see how nice this can look like, but I am not 100% sold for this yet...

I agree, but why does it even need to only be for content collections? isn't the fact that it's auto-created and has the label property set enough?

kitsunet · 2016-05-20T00:14:25Z

See inline comment 👎 for now

aertmann · 2016-05-20T05:07:31Z

TYPO3.TYPO3CR/Classes/TYPO3/TYPO3CR/Domain/Model/ExpressionBasedNodeLabelGenerator.php

+            $parentNode = $node->getParent();
+            $property = 'childNodes.' . $node->getName() . '.label';
+            if ($parentNode->getNodeType()->hasConfiguration($property)) {
+                $expression = $parentNode->getNodeType()->getConfiguration($property);


I'd prefer if this also accepted simple strings and not only expressions, since that's unnecessary most of the time

aertmann · 2016-05-20T05:10:41Z

Nice idea, I think we can make it work.. see inline comments

It's missing documentation as well though

dfeyer · 2016-07-11T22:53:32Z

@aertmann @kitsunet Now support string, and no dependency to the ContentCollection anymore, it's pretty generic and useful.

As discussed with @kitsunet last week, we need to take to not have too much configuration that can depend on the "context" (parent node, ...) or we will have hard time to debug it.

Next step a small documentation and this one is merge ready

dfeyer · 2016-11-03T19:07:25Z

Up to date with master and update the first PR comment to show the possibility to use a string or EEL expression as label.

kitsunet · 2016-11-10T09:44:43Z

👍 Shoudl be fine!

dfeyer · 2016-11-10T14:57:25Z

@aertmann If you can review again we can merge this one

dfeyer · 2017-12-05T12:15:01Z

@aertmann @kitsunet Maybe this can finaly be merged ;)

aertmann · 2017-12-05T15:43:17Z

Neos.ContentRepository/Resources/Private/Schema/NodeTypes.schema.yaml

@@ -42,6 +42,7 @@ additionalProperties:
            type: dictionary
            additionalProperties: FALSE
            properties:
+              'label': { type: string, description: "A string or an EEL expression for generating a node's of this node type's label. Alternatively an array with the key generatorClass and optional options." }


maybe more specific "and optional generator options."

aertmann · 2017-12-05T15:44:33Z

Neos.ContentRepository/Classes/Domain/Model/ExpressionBasedNodeLabelGenerator.php

     */
    public function getLabel(NodeInterface $node)
    {
-        $label = Utility::evaluateEelExpression($this->getExpression(), $this->eelEvaluator, array('node' => $node), $this->defaultContextConfiguration);
+        $label = null;
+        if ($node->getNodeType()->isOfType('TYPO3.Neos:ContentCollection') && $node->isAutoCreated()) {


why this limitation on only ContentCollection?

dfeyer · 2017-12-05T18:14:10Z

Thanks @aertmann for the review, all comments fixed

aertmann

🤗

kitsunet · 2017-12-10T10:58:36Z

I re-read the code and from a user perspective this is great, but I am still not convinced about the implementation. That's a lot of logic in the LabelGenerator that any person implementing the interface would have to replicate. Also The LabelGenerator shouldn't be in charge of figuring this out. If we want to do this, we might want to change the interface to tell the generator where to get the config from maybe.

dfeyer · 2018-05-08T20:12:07Z

@kitsunet What if we introduce an Abstract class with helper function, and a protected method to override the label for the automaticaly created child nodes ? Like this custom implementation can reuse the abstract class and we avoid changing the interface ?

dfeyer · 2018-05-08T20:14:03Z

And maybe a missing feature is the support of i18n keywords to have translatable labels ...

kdambekalns · 2018-06-25T07:40:45Z

This looks really useful, so could you (@dfeyer and @kitsunet) decide on a path forward? Thanks!

Sebobo · 2024-07-27T06:05:12Z

I would like to try to bring this into 8.4 as recently I was sad again in two projects that the feature doesn't exist yet and I had to introduce ContentCollection subtypes for no further reason than to have proper labels.

This change add a node type configuration to generate a custom node label for auto created child nodes: ‚Neos.NodeTypes:Page': superTypes: ‚Neos.Neos:Document': TRUE childNodes: main: label: ‚Main Content Collection' type: ‚Neos.Neos:ContentCollection' This allow to have a less technical content tree. This change include the schema validation and default label for default node types.

mhsdesign

Haha nice thanks for the restoration of this pr ^^
Would be great if you could create an upmerged version of this for Neos 9 as well (there we have different tests and the class was moved and the api changed ...)

dlubitz · 2024-09-06T10:53:18Z

@Sebobo This change has not been upmerged to Neos 9, as this will not work there anymore. Please provide a dedicated PR to 9.0 if this feature is also needed there.

dfeyer added I: WIP P: Node Types P: Neos labels May 19, 2016

dfeyer force-pushed the feature-custom-child-node-label branch from 576f54c to 96314fc Compare May 19, 2016 14:32

kitsunet reviewed May 20, 2016
View reviewed changes

aertmann reviewed May 20, 2016
View reviewed changes

aertmann changed the title ~~FEATURE: Add custom label for auto created child node~~ FEATURE: Custom label for auto created child nodes May 20, 2016

aertmann assigned dfeyer May 20, 2016

dfeyer removed the I: WIP label Jul 11, 2016

aertmann added I: ‌‌Merge conflict T: PHP labels Feb 17, 2017

aertmann reviewed Dec 5, 2017

View reviewed changes

aertmann approved these changes Dec 5, 2017

View reviewed changes

jonnitto requested a review from kitsunet November 6, 2018 16:08

markusguenther added the Feature label Nov 18, 2021

mhsdesign added the I: Wrong branch label Feb 8, 2024

mhsdesign marked this pull request as draft February 8, 2024 19:30

mhsdesign changed the base branch from 8.2 to 7.3 February 8, 2024 19:31

github-actions bot added the 7.3 label Feb 8, 2024

Sebobo self-requested a review July 27, 2024 06:04

Sebobo self-assigned this Jul 27, 2024

Sebobo added 8.4 and removed 7.3 labels Jul 27, 2024

Sebobo force-pushed the feature-custom-child-node-label branch from 2a9c67e to 4a06cce Compare July 27, 2024 06:50

Sebobo changed the base branch from 7.3 to 8.4 July 27, 2024 06:51

github-actions bot added 7.3 and removed 7.3 labels Jul 27, 2024

Sebobo force-pushed the feature-custom-child-node-label branch from 4a06cce to 3b9ec37 Compare July 27, 2024 06:52

Sebobo force-pushed the feature-custom-child-node-label branch from 3b9ec37 to 2e7c49e Compare July 27, 2024 06:54

TASK: Add tests for autocreated childnode labels

7bba496

Sebobo marked this pull request as ready for review July 27, 2024 07:08

Sebobo removed I: Wrong branch help wanted I: ‌‌Merge conflict labels Jul 27, 2024

Sebobo requested review from ahaeslich and pKallert July 27, 2024 07:35

Sebobo requested review from mhsdesign and dlubitz August 13, 2024 09:41

dlubitz approved these changes Aug 13, 2024

View reviewed changes

mhsdesign approved these changes Aug 13, 2024

View reviewed changes

Sebobo merged commit ed79f5f into neos:8.4 Aug 13, 2024
4 of 6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FEATURE: Custom label for auto created child nodes #530

FEATURE: Custom label for auto created child nodes #530

dfeyer commented May 19, 2016 •

edited by mhsdesign

Loading

mention-bot commented May 19, 2016

dfeyer commented May 19, 2016

kitsunet May 20, 2016 •

edited

Loading

aertmann May 20, 2016

kitsunet commented May 20, 2016

aertmann May 20, 2016

aertmann commented May 20, 2016 •

edited

Loading

dfeyer commented Jul 11, 2016

dfeyer commented Nov 3, 2016

kitsunet commented Nov 10, 2016

dfeyer commented Nov 10, 2016

dfeyer commented Dec 5, 2017

aertmann Dec 5, 2017

aertmann Dec 5, 2017

dfeyer commented Dec 5, 2017

aertmann left a comment

kitsunet commented Dec 10, 2017

dfeyer commented May 8, 2018

dfeyer commented May 8, 2018

kdambekalns commented Jun 25, 2018

Sebobo commented Jul 27, 2024

mhsdesign left a comment

dlubitz commented Sep 6, 2024

FEATURE: Custom label for auto created child nodes #530

FEATURE: Custom label for auto created child nodes #530

Conversation

dfeyer commented May 19, 2016 • edited by mhsdesign Loading

mention-bot commented May 19, 2016

dfeyer commented May 19, 2016

kitsunet May 20, 2016 • edited Loading

Choose a reason for hiding this comment

aertmann May 20, 2016

Choose a reason for hiding this comment

kitsunet commented May 20, 2016

aertmann May 20, 2016

Choose a reason for hiding this comment

aertmann commented May 20, 2016 • edited Loading

dfeyer commented Jul 11, 2016

dfeyer commented Nov 3, 2016

kitsunet commented Nov 10, 2016

dfeyer commented Nov 10, 2016

dfeyer commented Dec 5, 2017

aertmann Dec 5, 2017

Choose a reason for hiding this comment

aertmann Dec 5, 2017

Choose a reason for hiding this comment

dfeyer commented Dec 5, 2017

aertmann left a comment

Choose a reason for hiding this comment

kitsunet commented Dec 10, 2017

dfeyer commented May 8, 2018

dfeyer commented May 8, 2018

kdambekalns commented Jun 25, 2018

Sebobo commented Jul 27, 2024

mhsdesign left a comment

Choose a reason for hiding this comment

dlubitz commented Sep 6, 2024

dfeyer commented May 19, 2016 •

edited by mhsdesign

Loading

kitsunet May 20, 2016 •

edited

Loading

aertmann commented May 20, 2016 •

edited

Loading