Consider container multivalue children for closed summary

Returning to active since #2857112: Add summary method into paragraph entity is committed

If I understand correctly then the problem is with the nested paragraph so i updated it to display all referenced paragraphs. Also updated the getTextSummary() in Paragraphs to handle multivalue text field. Is this something we also want?

Yes, the problem is with nested paragraphs. In Paragraph.php we have a summary method that recursively generates a summary. The challenge is how to make this nice from UX perspective.

If I understood it right, @miro_dietiker suggests two possible solutions:

1. Display a child count if we have nested paragraphs
2. Display information about what this nested paragraphs are

Both should be implemented for now and which one is used should be configurable on the widget config.

Here is the initial patch and some thoughts.

1. Removed the configurability but i can add it to widget settings if we decide.

2. In the first iteration my summary was like "1 Text paragraph, 2 Image paragraphs, 1 Container". It grouped the paragraph types and used that as a summary.

3. I don't know what the plan for further development but are we considering to use maybe image representations for paragraph types. So the summary for the container paragraphs could be: "1 [text paragraph image], 2 [image paragraph image], 1 [container image]" and hovering on the images we can show summary of the individual paragraphs?

4. Here are some images of how containers look:
Here is the top container:

This is the container inside the top container:

How do we want to display summary for the container inside the container? Separate with [] or some indicator that is a summary of a container inside.

This should fix some test fails.

last fail

Created meta issue for discussion #2862083: [META] Improve paragraphs summary. And continue to improve this...

sorry wrong image. this one is correct.

Noticed that when the summary is closed by default the count is wrong so fixed that and will work on adding some more options to the getSummary() in paragraphs.

Added more options for the summary: allowed bundles, number of allowed summaries and if the behavior summaries should be shown.

Now that we display count of how many children there are what would be the best way to show everything when we limit the number of summaries?

Here are some options how to display closed summary if for example we have 5 children but the limit is to show 2 summaries:

1) 2 children *show 2 summaries* // Show wrong count, probably not a good option.
2) More then 2 children *show 2 summaries* // This is how right now it is displayed.
3) 5 children *show 2 summaries* // Another option

Also is this going to be relevant when we change to icons?

the bot is crazy

Yes, I already suggested on the original issue to add a empty $options argument so we can add additional options later on. I guess we now have to change the API, which is a bit unfortunate but only dev - > dev and not yet in a release.

1. Added options array instead of multiple arguments
2. Added a case for an empty nested.
3. Configured test accordingly.

Not sure why the edit button lowered a bit.

Fixed test fail and some minor changes.

Still has the problem with the lowered edit button.
Edit: This problem exists only in firefox, this issue does not affect it, maybe it is due some latest commits.

Only small stuff.

1. +++ b/src/Entity/Paragraph.php
   @@ -434,24 +441,35 @@ class Paragraph extends ContentEntityBase implements ParagraphInterface, EntityN
   +  public function getSummary($options = []) {
   
   +++ b/src/ParagraphInterface.php
   @@ -24,9 +24,12 @@ interface ParagraphInterface extends ContentEntityInterface, EntityOwnerInterfac
   +  public function getSummary($options = []);
   

   I am thinking here to use $options = NULL instead of $options = [];

2. +++ b/src/Entity/Paragraph.php
   @@ -434,24 +441,35 @@ class Paragraph extends ContentEntityBase implements ParagraphInterface, EntityN
   +    if ($this->bundle() !== NULL && (is_array($allowed_bundles) && !in_array($this->bundle(), $allowed_bundles))) {
   

   I don't think we want grouping conditions.

3. +++ b/src/Entity/Paragraph.php
   @@ -521,20 +556,56 @@ class Paragraph extends ContentEntityBase implements ParagraphInterface, EntityN
   +      return t('@summary', ['@summary' => $paragraph_summary]);
   

   I think is better to use $this->t();

Beside these, everything works fine.

Addressed #29:
1. Fixed the docs with array instead of NULL as default
2. Removed grouping conditions
3. $this->t was not available in the paragraph class

1. Removed count limit and allowed bundles.
2. With 1, description for more than count_limit got removed as well.
3. Fixed the t(), maybe... I'm not sure if I did this correctly.

Also, a suggestion:
We could use 'elements' instead of 'children' in the summary

The patch :)

+++ b/src/Entity/Paragraph.php
@@ -521,20 +551,48 @@ class Paragraph extends ContentEntityBase implements ParagraphInterface, EntityN
+   *   Array of paragraph options.

+++ b/src/ParagraphInterface.php
@@ -24,9 +24,12 @@ interface ParagraphInterface extends ContentEntityInterface, EntityOwnerInterfac
+   *   Array of paragraph options.

What are this options? This should be documented on the inteface for getSummary. The docblock for getNestedSummary can point to the getSummary on inteface for more information.

Shouldn't this new options be reflect on the formatter settings too? Should be that part of a follow up?

Addressed #36.
About the formatter, yes, that will be a follow-up. (I suppose there will be one for the test fix and one to add an additional option for the length of the summary (the truncate on 150 characters is not optimal in the library)).

1. Unified the two cases from #38 comment and checked for ParagraphsInterface accordingly.
2.Added new option depth_limit to limit the nesting summary (defaults to 1).
3.Added kernel test for the options array testing.

I need this for #2825575: Introduce a Drag & Drop Mode

1. +++ b/src/Entity/Paragraph.php
   @@ -521,20 +555,47 @@ class Paragraph extends ContentEntityBase implements ParagraphInterface, EntityN
   +    // Decrease the depth, since we are entering a nested paragraph.
   +    $options['depth_limit'] = $options['depth_limit'] - 1;
   

   I think it would be more readable to do this on the call to this, where you can just do a 'depth_limit' => $depth_limit - 1

2. +++ b/src/Entity/Paragraph.php
   @@ -521,20 +555,47 @@ class Paragraph extends ContentEntityBase implements ParagraphInterface, EntityN
   +      foreach ($this->{$field_name}->getValue() as $value) {
   +        if (isset($value['target_id']) && isset($value['target_revision_id'])) {
   +          $paragraph_entity = isset($value['entity']) ? $value['entity'] : $this->entityTypeManager()
   +            ->getStorage('paragraph')
   +            ->loadRevision($value['target_revision_id']);
   +          if ($paragraph_entity instanceof ParagraphInterface) {
   

   this can be simplified:

   * foreach $get($field_name) as $item
   * then $item->entity and so on. the original patch also on purpose did a ->entity check instead of id and then it automatically loads, so you can drop the whole loadRevision() fallback.
   * $paragraphs_entity => $paragraph or maybe $entity bcause we don't really know for sure if it's a paragraph yet at this point.

3. +++ b/src/Entity/Paragraph.php
   @@ -521,20 +555,47 @@ class Paragraph extends ContentEntityBase implements ParagraphInterface, EntityN
   +    return \Drupal::translation()
   +      ->formatPlural($summary_count, '1 child@summary', '@count children @summary', [
   +        '@count' => $summary_count,
   +        '@summary' => $paragraph_summary,
   +      ]);
   

   I'm confused about this summary count thing. it adds quite a bit of complexity and it seems to be counting different kinds of children depending on depth?

   if we get the summary count from the children, then we count basically each field, including text fields a child? that doesn't make sense? and we count possibly multivalue paragraphs then again as just one child.

   My recommendation would be to always just look at the actual, direct children and not the grand children. Pretty sure this causes more confusion than it actually provides something useful?

4. +++ b/src/ParagraphInterface.php
   @@ -24,9 +24,16 @@ interface ParagraphInterface extends ContentEntityInterface, EntityOwnerInterfac
   +   * @param array $options
   +   *   (optional) Array of additional options, with the following elements:
   +   *   - 'show_behavior_summary': Whether the summary should contain the
   +   *     behavior settings. TRUE enforces behavior settings in summary.
   +   *   - 'depth_limit': Depth limit of how many nested paragraph summaries are
   +   *     allowed.
   

   docs are unclear, doesn't say what is the default and what does "enforces behavior settings in summary" even mean? :)

Addressed #40
Extended text coverage with nested summary.

Fixed test.

This needs a re-roll, apart from that looks quite ok.

Rerolled and fixed tests.

Just two more things.

1. +++ b/src/Entity/Paragraph.php
   @@ -466,18 +481,38 @@ class Paragraph extends ContentEntityBase implements ParagraphInterface, EntityN
   +  protected function getSummaryCount() {
   

   Is this still used somewhere?

2. +++ b/src/Entity/Paragraph.php
   @@ -521,20 +556,34 @@ class Paragraph extends ContentEntityBase implements ParagraphInterface, EntityN
       *   Short summary for nested paragraphs type.
   

   Or NULL if the summary is empty.

1. This wasn't used, so I removed it for now, we can add it, if we need it for extended summary.
2. Change the description accordingly.

Committed, thanks. Please add the follow up to make this configurable on the widget, then this can be moved to Fixed.

Created follow-up #2890246: Make container summary configurable, setting this to fixed.