Issue #3455312 by joseph.olstad, smulvih2, vladimiraus, jurgenhaas, project...

Issue #3455312 by joseph.olstad, smulvih2, vladimiraus, jurgenhaas, project update bot: Automated Drupal 11 compatibility fixes for toc_api

.cspell-project-words.txt

+contenu
+rockowitz
+selectmenu
+spécial
+strto
+tocs

css/toc.tree.css

@@ -7,7 +7,7 @@
  * Add border to tree when displayed within a node
  */
 .node .toc-tree {
-  border: 1px solid #ccc;
-  padding: 0 1em;
   margin: 1em 0;
+  padding: 0 1em;
+  border: 1px solid #ccc;
 }

js/toc.menu.js

@@ -4,19 +4,15 @@
  */
 
 (function ($, Drupal) {
-
-  "use strict";
-
   Drupal.behaviors.tocMenu = {
-    attach: function (context) {
+    attach(context) {
       $('form.toc-menu > select', context).change(function () {
-        var value = $(this).val();
+        const value = this.value;
         if (value) {
-          location.hash = value;
+          window.location.hash = value;
         }
         this.selectedIndex = 0;
       });
-    }
+    },
   };
-
 })(jQuery, Drupal);

js/toc_type.js

@@ -4,25 +4,37 @@
  */
 
 (function ($, Drupal, once) {
-
-  "use strict";
-
-  Drupal.behaviors.tocTypeOptions = {
-    attach: function (context) {
-      $(once('.js-toc-type-options-header-min, .js-toc-type-options-header-max', context)).change(toggleHeaders);
-    }
-  };
-  toggleHeaders();
-
   function toggleHeaders() {
-    var min = $('.js-toc-type-options-header-min').val();
-    var max = $('.js-toc-type-options-header-max').val();
+    const min = parseInt(
+      document.querySelector('.js-toc-type-options-header-min')?.value || 1,
+      10,
+    );
+    const max = parseInt(
+      document.querySelector('.js-toc-type-options-header-max')?.value || 6,
+      10,
+    );
 
-    for (var i = 1; i <= 6; i++) {
-      // Having to use the id instead of $('.js-toc-type-options-header-h' + i).
-      var $header = $('details[id$="-headers-h' + i + '"]');
-      (i >= min && i <= max) ? $header.show() : $header.hide();
+    for (let i = 1; i <= 6; i++) {
+      const $header = $(`details[id$="-headers-h${i}"]`);
+      if (i >= min && i <= max) {
+        $header.show();
+      } else {
+        $header.hide();
+      }
     }
   }
 
+  Drupal.behaviors.tocTypeOptions = {
+    attach(context) {
+      once(
+        'toc-type-header-change',
+        '.js-toc-type-options-header-min, .js-toc-type-options-header-max',
+        context,
+      ).forEach((el) => {
+        el.addEventListener('change', toggleHeaders);
+      });
+
+      toggleHeaders();
+    },
+  };
 })(jQuery, Drupal, once);

modules/toc_api_example/toc_api_example.info.yml

@@ -2,6 +2,6 @@ name: 'TOC API example'
 type: module
 description: 'Example of a custom implementation of the TOC API that adds a table of contents to specified content types.'
 package: 'Example modules'
-core_version_requirement: ^9.4 || ^10.0
+core_version_requirement: ^9.5 || ^10.2 || ^11.0
 dependencies:
   - toc_api:toc_api

modules/toc_api_example/toc_api_example.module

@@ -2,24 +2,25 @@
 
 /**
  * @file
- * Example of a custom implementation of the TOC API that adds a table of contents to specified content types.
+ * Example of a custom implementation of the TOC API.
  */
 
-use Drupal\node\NodeInterface;
 use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
+use Drupal\node\NodeInterface;
 use Drupal\toc_api\Entity\TocType;
 
 /**
  * Implements hook_node_view().
  */
-function toc_api_example_node_view(array &$build, NodeInterface $node, EntityViewDisplayInterface $display, $view_mode) {
-  // Add TOC to 'page' and 'article' content types that are being viewed as a full (page) with a body field.
+function toc_api_example_node_view(array &$build, NodeInterface $node, EntityViewDisplayInterface $display, string $view_mode): void {
+  // Add TOC to 'page' and 'article' content types that are being viewed as a
+  // full (page) with a body field.
   if (in_array($node->getType(), ['page', 'article']) && $view_mode == 'full' && isset($build['body'][0])) {
     // Get the completely render (and filtered) body value.
     $body = (string) \Drupal::service('renderer')->render($build['body'][0]);
 
     // Get 'default' TOC type options.
-    /** @var \Drupal\toc_api\TocTypeInterface $toc_type */
+    /** @var \Drupal\toc_api\TocTypeInterface|null $toc_type */
     $toc_type = TocType::load('default');
     $options = ($toc_type) ? $toc_type->getOptions() : [];
 

phpstan.neon

+parameters:
+  level: 6
+  ignoreErrors:
+    - identifier: missingType.iterableValue

src/Entity/TocType.php

@@ -64,9 +64,9 @@ class TocType extends ConfigEntityBase implements TocTypeInterface {
   /**
    * The TOC type options.
    *
-   * @var array
+   * @var array|null
    */
-  protected $options;
+  protected $options = NULL;
 
   /**
    * {@inheritdoc}

src/Plugin/Block/TocBlockBase.php

@@ -3,15 +3,19 @@
 namespace Drupal\toc_api\Plugin\Block;
 
 use Drupal\Core\Access\AccessResult;
+use Drupal\Core\Access\AccessResultInterface;
 use Drupal\Core\Block\BlockBase;
+use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
 use Drupal\Core\Routing\RouteMatchInterface;
 use Drupal\Core\Session\AccountInterface;
+use Drupal\node\NodeInterface;
+use Drupal\toc_api\TocInterface;
+use Drupal\toc_api\TocManagerInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
- * Provides a base TOC block which displays the current TOC module's TOC in a
- * block.
+ * Provides a base block which displays the current TOC module's TOC in a block.
  */
 abstract class TocBlockBase extends BlockBase implements ContainerFactoryPluginInterface {
 
@@ -20,7 +24,21 @@ abstract class TocBlockBase extends BlockBase implements ContainerFactoryPluginI
    *
    * @var \Drupal\Core\Routing\RouteMatchInterface
    */
-  protected $routeMatch;
+  protected RouteMatchInterface $routeMatch;
+
+  /**
+   * The entity type manager.
+   *
+   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
+   */
+  protected EntityTypeManagerInterface $entityTypeManager;
+
+  /**
+   * The TOC manager.
+   *
+   * @var \Drupal\toc_api\TocManagerInterface
+   */
+  protected TocManagerInterface $tocManager;
 
   /**
    * Creates a LocalActionsBlock instance.
@@ -33,34 +51,38 @@ abstract class TocBlockBase extends BlockBase implements ContainerFactoryPluginI
    *   The plugin implementation definition.
    * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
    *   The route match.
+   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
+   *   The entity type manager.
+   * @param \Drupal\toc_api\TocManagerInterface $toc_manager
+   *   The TOC manager.
    */
-  public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteMatchInterface $route_match) {
+  final public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteMatchInterface $route_match, EntityTypeManagerInterface $entity_type_manager, TocManagerInterface $toc_manager) {
     parent::__construct($configuration, $plugin_id, $plugin_definition);
     $this->routeMatch = $route_match;
+    $this->entityTypeManager = $entity_type_manager;
+    $this->tocManager = $toc_manager;
   }
 
   /**
    * {@inheritdoc}
    */
-  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition): static {
     return new static(
       $configuration,
       $plugin_id,
       $plugin_definition,
-      $container->get('current_route_match')
+      $container->get('current_route_match'),
+      $container->get('entity_type.manager'),
+      $container->get('toc_api.manager')
     );
   }
 
   /**
    * {@inheritdoc}
    */
-  public function build() {
+  public function build(): array {
     $toc = $this->getCurrentToc();
 
-    if (empty($toc)) {
-      return [];
-    }
-
     // Build the TOC.
     $options = $toc->getOptions();
     $build = [
@@ -82,12 +104,9 @@ abstract class TocBlockBase extends BlockBase implements ContainerFactoryPluginI
    * @return \Drupal\toc_api\TocInterface
    *   A TOC object.
    */
-  protected function getCurrentToc() {
-    /** @var \Drupal\toc_api\TocManagerInterface $toc_manager */
-    $toc_manager = \Drupal::service('toc_api.manager');
-
+  protected function getCurrentToc(): TocInterface {
     // Get the new TOC instance using the module name.
-    return $toc_manager->getToc($this->getCurrentTocId());
+    return $this->tocManager->getToc($this->getCurrentTocId());
   }
 
   /**
@@ -99,21 +118,21 @@ abstract class TocBlockBase extends BlockBase implements ContainerFactoryPluginI
    * @return string
    *   The current TOC block's plugin ID.
    */
-  protected function getCurrentTocId() {
+  protected function getCurrentTocId(): string {
     return $this->pluginId;
   }
 
   /**
    * {@inheritdoc}
    */
-  public function getCacheContexts() {
+  public function getCacheContexts(): array {
     return ['route'];
   }
 
   /**
    * {@inheritdoc}
    */
-  public function getCacheTags() {
+  public function getCacheTags(): array {
     $node = $this->getCurrentNode();
     return ($node) ? ['node:' . $node->id()] : [];
   }
@@ -122,14 +141,15 @@ abstract class TocBlockBase extends BlockBase implements ContainerFactoryPluginI
    * Load the node associated with the current request.
    *
    * @return \Drupal\node\NodeInterface|null
-   *   A node entity, or NULL if no node is not found.
+   *   A node entity, or NULL if no node is found.
    */
-  protected function getCurrentNode() {
+  protected function getCurrentNode(): ?NodeInterface {
     switch ($this->routeMatch->getRouteName()) {
       // Look at the request's node revision.
       case 'node.revision_show':
-        return node_revision_load($this->routeMatch
-          ->getParameter('node_revision'));
+        $node_storage = $this->entityTypeManager->getStorage('node');
+        $node = $node_storage->loadRevision($this->routeMatch->getParameter('node_revision'));
+        return ($node instanceof NodeInterface) ? $node : NULL;
 
       // Look at the request's node preview.
       case 'entity.node.preview':
@@ -146,14 +166,10 @@ abstract class TocBlockBase extends BlockBase implements ContainerFactoryPluginI
   /**
    * {@inheritdoc}
    */
-  protected function blockAccess(AccountInterface $account) {
-    $this->getCurrentTocId();
-    /** @var \Drupal\toc_api\TocManagerInterface $toc_manager */
-    $toc_manager = \Drupal::service('toc_api.manager');
-
+  protected function blockAccess(AccountInterface $account): AccessResultInterface {
     // Get the new TOC instance and see if it is visible and should be
     // displayed in a block.
-    $toc = $toc_manager->getToc($this->getCurrentTocId());
+    $toc = $this->tocManager->getToc($this->getCurrentTocId());
 
     if (!$toc || !$toc->isVisible() || !$toc->isBlock()) {
       return AccessResult::forbidden();

src/Toc.php

@@ -72,9 +72,9 @@ class Toc implements TocInterface {
   /**
    * The number of root headers found in the content.
    *
-   * @var int
+   * @var int|null
    */
-  protected $headerCount;
+  protected $headerCount = NULL;
 
   /**
    * The source content with unique header ids.
@@ -100,9 +100,9 @@ class Toc implements TocInterface {
   /**
    * The toc represent as a tree.
    *
-   * @var array
+   * @var array|null
    */
-  protected $tree;
+  protected $tree = NULL;
 
   /**
    * Existing in the source content IDs.
@@ -192,16 +192,12 @@ class Toc implements TocInterface {
     $this->allowedTags = $this->formatter()->convertAllowedTagsToArray($this->options['header_allowed_tags']);
 
     $this->initialize();
-
-    // DEBUG:
-    // dsm($this->getIndex());
-    // dsm($this->getTree());
   }
 
   /**
    * Initializes the table of content index and ensure unique header ids.
    */
-  protected function initialize() {
+  protected function initialize(): void {
     $this->index = [];
 
     // Setup an empty array of keys to track the index's keys.
@@ -340,7 +336,7 @@ class Toc implements TocInterface {
           '#markup' => $header_html,
           '#allowed_tags' => $this->getAllowedTags(),
         ],
-        'url' => Url::fromRoute('<none>', NULL, [
+        'url' => Url::fromRoute('<none>', [], [
           'fragment' => $header_id,
         ]),
       ];
@@ -356,6 +352,7 @@ class Toc implements TocInterface {
    *   The TOC formatter
    */
   protected function formatter() {
+    // @phpstan-ignore-next-line
     return \Drupal::service('toc_api.formatter');
   }
 
@@ -398,7 +395,8 @@ class Toc implements TocInterface {
    * {@inheritdoc}
    */
   public function getHeaderCount() {
-    if (!isset($this->headerCount)) {
+    if ($this->headerCount === NULL) {
+      $this->headerCount = 0;
       foreach ($this->index as $item) {
         if (empty($item['parent'])) {
           $this->headerCount++;
@@ -419,7 +417,7 @@ class Toc implements TocInterface {
    * {@inheritdoc}
    */
   public function getTree() {
-    if (!isset($this->tree)) {
+    if ($this->tree === NULL) {
       $this->tree = [
         'title' => $this->options['title'],
       ];
@@ -445,7 +443,7 @@ class Toc implements TocInterface {
    * @param array $children
    *   An array of keys to be associative to the parent header item.
    */
-  protected function buildTree(array &$item, array $children) {
+  protected function buildTree(array &$item, array $children): void {
     $item['below_type'] = '';
     $item['below'] = [];
     foreach ($children as $key) {
@@ -498,8 +496,6 @@ class Toc implements TocInterface {
    *
    * @param \DOMDocument $dom
    *   DOM object.
-   *
-   * @return void
    */
   protected function collectExistingIds(\DOMDocument $dom): void {
     $xpath = new \DOMXPath($dom);
@@ -518,8 +514,6 @@ class Toc implements TocInterface {
    *
    * @param \DOMDocument $dom
    *   DOM object.
-   *
-   * @return void
    */
   protected function useIdsOnly(\DOMDocument $dom): void {
     $xpath = new \DOMXPath($dom);

src/TocBuilder.php

@@ -4,11 +4,14 @@ namespace Drupal\toc_api;
 
 use Drupal\Component\Utility\Html;
 use Drupal\Component\Utility\Xss;
+use Drupal\Core\Render\Markup;
 use Drupal\Core\Render\RendererInterface;
 
 /**
- * Defines a service that builds and renders a table of contents and update an
- * HTML document's headers.
+ * Defines a service to build TOC.
+ *
+ * This service builds and renders a table of contents and update an HTML
+ * document's headers.
  */
 class TocBuilder implements TocBuilderInterface {
 
@@ -150,10 +153,13 @@ class TocBuilder implements TocBuilderInterface {
    */
   public function renderToc(TocInterface $toc) {
     if (!$toc->isVisible()) {
-      return '';
+      return Markup::create('');
     }
 
     $build = $this->buildToc($toc);
+    if (empty($build)) {
+      return Markup::create('');
+    }
     return $this->renderer->render($build);
   }
 

src/TocBuilderInterface.php

@@ -26,8 +26,8 @@ interface TocBuilderInterface {
    *   A TOC object.
    *
    * @return array
-   *   A render array containing the table of content's body content with bookmarked, typed, and custom
-   *   headers with back to top links.
+   *   A render array containing the table of content's body content with
+   *   bookmarked, typed, and custom headers with back to top links.
    */
   public function buildContent(TocInterface $toc);
 

src/TocFormatter.php

@@ -3,7 +3,7 @@
 namespace Drupal\toc_api;
 
 /**
- * Defines a service for formatting a table of content's headers, numbering, and ids..
+ * Defines a service for formatting a TOC headers, numbering, and ids.
  */
 class TocFormatter implements TocFormatterInterface {
 
@@ -12,7 +12,90 @@ class TocFormatter implements TocFormatterInterface {
    */
   public function convertStringToId($text) {
     // Replace accents with their counterparts.
-    $text = strtr($text, ['Š' => 'S', 'š' => 's', 'Đ' => 'Dj', 'đ' => 'dj', 'Ž' => 'Z', 'ž' => 'z', 'Č' => 'C', 'č' => 'c', 'Ć' => 'C', 'ć' => 'c', 'À' => 'A', 'Á' => 'A', 'Â' => 'A', 'Ã' => 'A', 'Ä' => 'A', 'Å' => 'A', 'Æ' => 'A', 'Ç' => 'C', 'È' => 'E', 'É' => 'E', 'Ê' => 'E', 'Ë' => 'E', 'Ì' => 'I', 'Í' => 'I', 'Î' => 'I', 'Ï' => 'I', 'Ñ' => 'N', 'Ò' => 'O', 'Ó' => 'O', 'Ô' => 'O', 'Õ' => 'O', 'Ö' => 'O', 'Ø' => 'O', 'Ù' => 'U', 'Ú' => 'U', 'Û' => 'U', 'Ü' => 'U', 'Ý' => 'Y', 'Þ' => 'B', 'ß' => 'Ss', 'à' => 'a', 'á' => 'a', 'â' => 'a', 'ã' => 'a', 'ä' => 'a', 'å' => 'a', 'æ' => 'a', 'ç' => 'c', 'è' => 'e', 'é' => 'e', 'ê' => 'e', 'ë' => 'e', 'ì' => 'i', 'í' => 'i', 'î' => 'i', 'ï' => 'i', 'ð' => 'o', 'ñ' => 'n', 'ò' => 'o', 'ó' => 'o', 'ô' => 'o', 'õ' => 'o', 'ö' => 'o', 'ø' => 'o', 'ù' => 'u', 'ú' => 'u', 'û' => 'u', 'ý' => 'y', 'þ' => 'b', 'ÿ' => 'y', 'Ŕ' => 'R', 'ŕ' => 'r', 'Ā' => 'A', 'Ē' => 'E', 'Ī' => 'I', 'Ō' => 'O', 'Ū' => 'U', 'ā' => 'a', 'ē' => 'e', 'ī' => 'i', 'ō' => 'o', 'ū' => 'u']);
+    $text = strtr($text, [
+      'Š' => 'S',
+      'š' => 's',
+      'Đ' => 'Dj',
+      'đ' => 'dj',
+      'Ž' => 'Z',
+      'ž' => 'z',
+      'Č' => 'C',
+      'č' => 'c',
+      'Ć' => 'C',
+      'ć' => 'c',
+      'À' => 'A',
+      'Á' => 'A',
+      'Â' => 'A',
+      'Ã' => 'A',
+      'Ä' => 'A',
+      'Å' => 'A',
+      'Æ' => 'A',
+      'Ç' => 'C',
+      'È' => 'E',
+      'É' => 'E',
+      'Ê' => 'E',
+      'Ë' => 'E',
+      'Ì' => 'I',
+      'Í' => 'I',
+      'Î' => 'I',
+      'Ï' => 'I',
+      'Ñ' => 'N',
+      'Ò' => 'O',
+      'Ó' => 'O',
+      'Ô' => 'O',
+      'Õ' => 'O',
+      'Ö' => 'O',
+      'Ø' => 'O',
+      'Ù' => 'U',
+      'Ú' => 'U',
+      'Û' => 'U',
+      'Ü' => 'U',
+      'Ý' => 'Y',
+      'Þ' => 'B',
+      'ß' => 'Ss',
+      'à' => 'a',
+      'á' => 'a',
+      'â' => 'a',
+      'ã' => 'a',
+      'ä' => 'a',
+      'å' => 'a',
+      'æ' => 'a',
+      'ç' => 'c',
+      'è' => 'e',
+      'é' => 'e',
+      'ê' => 'e',
+      'ë' => 'e',
+      'ì' => 'i',
+      'í' => 'i',
+      'î' => 'i',
+      'ï' => 'i',
+      'ð' => 'o',
+      'ñ' => 'n',
+      'ò' => 'o',
+      'ó' => 'o',
+      'ô' => 'o',
+      'õ' => 'o',
+      'ö' => 'o',
+      'ø' => 'o',
+      'ù' => 'u',
+      'ú' => 'u',
+      'û' => 'u',
+      'ý' => 'y',
+      'þ' => 'b',
+      'ÿ' => 'y',
+      'Ŕ' => 'R',
+      'ŕ' => 'r',
+      'Ā' => 'A',
+      'Ē' => 'E',
+      'Ī' => 'I',
+      'Ō' => 'O',
+      'Ū' => 'U',
+      'ā' => 'a',
+      'ē' => 'e',
+      'ī' => 'i',
+      'ō' => 'o',
+      'ū' => 'u',
+    ]);
 
     // Lowercase.
     $text = strtolower($text);
@@ -40,6 +123,10 @@ class TocFormatter implements TocFormatterInterface {
    * {@inheritdoc}
    */
   public function convertNumberToListTypeValue($number, $type) {
+    if ($type === NULL) {
+      $type = '';
+    }
+
     $case_func = NULL;
     // Check if type should upper or lower cased.
     if (preg_match('/^(upper|lower)-(.+)$/', (string) $type, $match)) {
@@ -72,7 +159,21 @@ class TocFormatter implements TocFormatterInterface {
    * {@inheritdoc}
    */
   public function convertNumberToRomanNumeral($number) {
-    $roman_numerals = ['M' => 1000, 'CM' => 900, 'D' => 500, 'CD' => 400, 'C' => 100, 'XC' => 90, 'L' => 50, 'XL' => 40, 'X' => 10, 'IX' => 9, 'V' => 5, 'IV' => 4, 'I' => 1];
+    $roman_numerals = [
+      'M' => 1000,
+      'CM' => 900,
+      'D' => 500,
+      'CD' => 400,
+      'C' => 100,
+      'XC' => 90,
+      'L' => 50,
+      'XL' => 40,
+      'X' => 10,
+      'IX' => 9,
+      'V' => 5,
+      'IV' => 4,
+      'I' => 1,
+    ];
     $result = '';
     foreach ($roman_numerals as $roman_numeral => $roman_number) {
       $matches = intval($number / $roman_number);
@@ -86,7 +187,34 @@ class TocFormatter implements TocFormatterInterface {
    * {@inheritdoc}
    */
   public function convertNumberToLetter($number) {
-    static $letters = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z'];
+    static $letters = [
+      'a',
+      'b',
+      'c',
+      'd',
+      'e',
+      'f',
+      'g',
+      'h',
+      'i',
+      'j',
+      'k',
+      'l',
+      'm',
+      'n',
+      'o',
+      'p',
+      'q',
+      'r',
+      's',
+      't',
+      'u',
+      'v',
+      'w',
+      'x',
+      'y',
+      'z',
+    ];
     return $letters[(($number - 1) % 26)];
   }
 

src/TocFormatterInterface.php

@@ -38,7 +38,7 @@ interface TocFormatterInterface {
    *
    * @param int $number
    *   A number.
-   * @param string $type
+   * @param string|null $type
    *   The HTML5 list-style-type.
    *
    * @return string

src/TocInterface.php

@@ -50,7 +50,9 @@ interface TocInterface {
   /**
    * Returns a hierarchical array of headers.
    *
-   * @return array
+   * @todo update the description text.
+   *
+   * @return int
    *   An hierarchical array of headers.
    */
   public function getHeaderCount();

src/TocManager.php

@@ -38,10 +38,11 @@ class TocManager implements TocManagerInterface {
   /**
    * {@inheritdoc}
    */
-  public function create($id, $source, array $options = []) {
+  public function create(string $id, string $source, array $options = []): TocInterface {
     // Merge default TOC type options with passed options.
-    /** @var \Drupal\toc_api\TocTypeInterface $default_toc */
-    if ($default_toc = TocType::load('default')) {
+    /** @var \Drupal\toc_api\TocTypeInterface|null $default_toc */
+    $default_toc = TocType::load('default');
+    if ($default_toc !== NULL) {
       $options = NestedArray::mergeDeep($default_toc->getOptions(), $options);
     }
 
@@ -53,14 +54,14 @@ class TocManager implements TocManagerInterface {
   /**
    * {@inheritdoc}
    */
-  public function getToc($id) {
+  public function getToc(string $id): ?TocInterface {
     return (isset($this->tocs[$id])) ? $this->tocs[$id] : NULL;
   }
 
   /**
    * {@inheritdoc}
    */
-  public function reset($id = NULL) {
+  public function reset(?string $id = NULL): void {
     if ($id === NULL) {
       $this->tocs = [];
     }

src/TocManagerInterface.php

@@ -23,7 +23,7 @@ interface TocManagerInterface {
    * @return \Drupal\toc_api\TocInterface
    *   A new TOC object.
    */
-  public function create($id, $source, array $options = []);
+  public function create(string $id, string $source, array $options = []): TocInterface;
 
   /**
    * Get the current TOC instance.
@@ -32,10 +32,10 @@ interface TocManagerInterface {
    *   ID used to track the TOC object's instance. Typically, the ID can be
    *   the TOC implementation's module name.
    *
-   * @return \Drupal\toc_api\TocInterface
+   * @return \Drupal\toc_api\TocInterface|null
    *   The current TOC instance.
    */
-  public function getToc($id);
+  public function getToc(string $id): ?TocInterface;
 
   /**
    * Reset the current TOC instance.
@@ -44,6 +44,6 @@ interface TocManagerInterface {
    *   ID used to track the TOC object's instance. Typically, the ID can be
    *   the TOC implementation's module name.
    */
-  public function reset($id = NULL);
+  public function reset(?string $id = NULL): void;
 
 }

src/TocTypeForm.php

@@ -48,13 +48,14 @@ class TocTypeForm extends EntityForm {
    *
    * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
    *   The entity query factory.
-   *
    * @param \Drupal\Core\Theme\Registry $theme_registry
    *   The theme registry.
    * @param \Drupal\Core\Theme\ThemeManagerInterface $theme_manager
    *   The theme manager.
+   * @param \Drupal\Core\Theme\ThemeInitializationInterface $theme_initialization
+   *   The theme initialization logic.
    */
-  public function __construct(EntityTypeManagerInterface $entity_type_manager, Registry $theme_registry, ThemeManagerInterface $theme_manager, ThemeInitializationInterface $theme_initialization) {
+  final public function __construct(EntityTypeManagerInterface $entity_type_manager, Registry $theme_registry, ThemeManagerInterface $theme_manager, ThemeInitializationInterface $theme_initialization) {
     $this->entityTypeManager = $entity_type_manager;
     $this->themeRegistry = $theme_registry;
     $this->themeManager = $theme_manager;
@@ -64,7 +65,7 @@ class TocTypeForm extends EntityForm {
   /**
    * {@inheritdoc}
    */
-  public static function create(ContainerInterface $container) {
+  public static function create(ContainerInterface $container): static {
     return new static(
       $container->get('entity_type.manager'),
       $container->get('theme.registry'),
@@ -78,6 +79,9 @@ class TocTypeForm extends EntityForm {
    */
   public function buildForm(array $form, FormStateInterface $form_state) {
     $toc_type = $this->entity;
+    if (!($toc_type instanceof TocTypeInterface)) {
+      return $form;
+    }
     $options = $toc_type->getOptions();
 
     // An associative array of HTML header tags keyed by level.
@@ -309,8 +313,7 @@ class TocTypeForm extends EntityForm {
       $form['options']['numbering']['headers'][$header_tag]['custom'] = [
         '#title' => $this->t('Customize @tag numbering', [
           '@tag' => $header_tag,
-        ]
-        ),
+        ]),
         '#type' => 'checkbox',
         '#default_value' => $header_options['custom'],
         '#attributes' => ['class' => ["js-toc-type-options-headers-$header_tag-custom"]],
@@ -367,7 +370,7 @@ class TocTypeForm extends EntityForm {
   /**
    * {@inheritdoc}
    */
-  public function submitForm(array &$form, FormStateInterface $form_state) {
+  public function submitForm(array &$form, FormStateInterface $form_state): void {
     $values = $form_state->getValues();
 
     $options = $values['general'] + $values['header'] + $values['top'] + $values['numbering'];
@@ -405,6 +408,7 @@ class TocTypeForm extends EntityForm {
     $this->messenger()->addMessage($this->t('Table of contents type %label saved.', ['%label' => $toc_type->label()]));
 
     $form_state->setRedirect('entity.toc_type.collection');
+    return parent::save($form, $form_state);
   }
 
   /**
@@ -418,13 +422,12 @@ class TocTypeForm extends EntityForm {
    */
   public function exists($id) {
     return (bool) $this->entityTypeManager
-      ->get('toc_type')
-      ->condition('id', $id)
-      ->execute();
+      ->getStorage('toc_type')
+      ->load($id);
   }
 
   /**
-   * Get TOC templates from the theme registry for the default theme as an associative array of options.
+   * Get TOC templates from the theme registry for the default theme.
    *
    * @return array
    *   TOC templates as an associative array of options.

src/TocTypeListBuilder.php

@@ -26,6 +26,9 @@ class TocTypeListBuilder extends ConfigEntityListBuilder {
    * {@inheritdoc}
    */
   public function buildRow(EntityInterface $entity) {
+    if (!($entity instanceof TocTypeInterface)) {
+      return parent::buildRow($entity);
+    }
     $options = $entity->getOptions();
 
     $row['label'] = $entity->label();

templates/toc-menu.html.twig

@@ -9,7 +9,7 @@
  * - index: List of header items. Each header item contains:
  *   - prefix: The header option prefix. Either indentation or the complete path.
  *   - title: The header title.
- *   - url: The header fragrment (ie hash) URL, instance of \Drupal\Core\Url.
+ *   - url: The header fragment (ie hash) URL, instance of \Drupal\Core\Url.
  *
  * @ingroup themeable
  */