Use view mode in 'import from library' and links template suggestion

Ok, let's forget the template suggestion, I can do it in UI Suite Bootstrap if needed.

Let's focus on using a view mode for the link title.

Oo - this is a great idea!

Updating issue title and summary to remove the template suggestion part.

Thanks for your feedback.

How do we achieve that?

1: Should we use "default" view mode? And what about current markup?

2: Or introduce a setting (so a new settings form for the module) to select which view mode to use and also among the choice a fallback to current markup?

There is a bit of an issue with using a configurable view mode; users could very easily break the choose modal entirely.

For example, it's possible to configure the image field to be linked, and the whole display of the template is already a link so the contents needs to be compatible with being surrounded by a link. Also now that other fields can be added, those could also cause problems if they were added as part of this view mode. Do you have a suggestion for how to avoid that?

What about an alternative where the title contents is generated by a separate function that could be overwritten by an individual site?

If using view mode is too risky, then yes, helping a website to override the link title easily will be a very nice first step.

Calling/overridding a service, with parameter the section library content entity is passed.

I've pushed a commit that moves the label generation to it's own function. This is similar to other functions broken out in ChooseSectionFromLibraryController.php that allow for overwriting the default image, adding a custom description, and customizing the logic for getting the sections to display as options.

To override any of those options, you'd need a RouteSubscriber in a custom module:

<?php

namespace Drupal\MY_MODULE\Routing;

use Drupal\Core\Routing\RouteSubscriberBase;
use Symfony\Component\Routing\RouteCollection;

/**
 * Overrides the default section library form classes.
 */
class RouteSubscriber extends RouteSubscriberBase {

  /**
   * {@inheritdoc}
   */
  public function alterRoutes(RouteCollection $collection) {
    // Override the original template view class with a customized class.
    if ($route = $collection->get('section_library.choose_template_from_library')) {
      $route->setDefault('_controller', '\Drupal\MY_MODULE\Controller\CUSTOMChooseSectionFromLibraryController::build');
    }
  }

}

And then in your custom controller:

<?php

namespace Drupal\MY_MODULE\Controller;

use Drupal\Component\Render\MarkupInterface;
use Drupal\Core\Render\Markup;
use Drupal\section_library\Controller\ChooseSectionFromLibraryController;

/**
 * Overrides ChooseSectionFromLibraryController.
 */
class CUSTOMChooseSectionFromLibraryController extends ChooseSectionFromLibraryController {

  /**
   * {@inheritdoc}
   */
  protected function getSectionLinkLabel($section, string $default_path = '', string $image_style = ''): MarkupInterface|string {
    // Insert whatever custom label markup you would prefer.
    return Markup::create('<span class="section-library-link-label-custom">' . $section->label() . '</span>');
  }

  /**
   * {@inheritdoc}
   */
  protected function getDescription() {
    return $this->t('Choose a section or template to add to the layout.');
  }

}

Thanks a lot for your work.

One or two minor review comments, so changing status to needs work.

I confirm that the current behavior is preserved.

I have not tested to override with a custom controller, I trust that it will work.

Working on MR comments.

@lavanyatalwar the only change is using SectionLibraryTemplateInterface so I'm just going to tweak that.

Updated to use an interface -

Thanks!

@grimreaper mind giving this one more check? I added the logger with dependency injection. I'm debating adding a post-update hook to clear the cache but there are other hooks that would clear cache between the last release and the next one -

Ok, testing.

I don't think there is a need to clear cache, as dependency injection is done with a create method and not by a services.yml file.

OH. Thank you for clarifying that!

I confirm that there is no need of update hook.

It works!

use Drupal\Component\Render\FormattableMarkup;
use Drupal\Component\Render\MarkupInterface;
use Drupal\Core\Theme\Icon\IconDefinition;
use Drupal\section_library\Controller\ChooseSectionFromLibraryController as ContribChooseSectionFromLibraryController;
use Drupal\section_library\Entity\SectionLibraryTemplateInterface;

/**
 * Overrides ChooseSectionFromLibraryController.
 */
class ChooseSectionFromLibraryController extends ContribChooseSectionFromLibraryController {

  /**
   * {@inheritdoc}
   */
  protected function getSectionLinkLabel(SectionLibraryTemplateInterface $section, string $default_path = '', string $image_style = ''): MarkupInterface|string {
    $defaultMarkup = parent::getSectionLinkLabel($section, $default_path, $image_style);
    if (!$section->hasField('field_icon')) {
      return $defaultMarkup;
    }
    $iconField = $section->get('field_icon');
    if ($iconField->isEmpty()) {
      return $defaultMarkup;
    }

    $iconValue = $iconField->getValue();
    if (!isset($iconValue[0]['target_id'])) {
      return $defaultMarkup;
    }

    $icon_element = IconDefinition::getRenderable($iconValue[0]['target_id'], [
      // Fontawesome.
      'width' => '2em',
      'height' => '2em',
      // Bootstrap.
      'size' => '2em',
    ]);
    return new FormattableMarkup('<span class="text-center mb-3 section-library-link-img">@icon</span>@title', [
      '@title' => $defaultMarkup,
      '@icon' => $this->renderer->renderInIsolation($icon_element),
    ]);
  }

}

Awesome!

Updating this to the relevant major version.

Automatically closed - issue fixed for 2 weeks with no activity.