Contrib.social

Update scanner_fixer_api_example class names and plugin IDs

Open on Drupal.org →
Created on 27 August 2025, 2 months ago

Problem/Motivation

The 2.0.x version of the module has a scanner_fixer_api_example sub-module with more-realistic Scanner, Fixer, and Solution examples.

The code has some inconsistencies, however:

  1. The Fixer calls \taxonomy_build_node_index() but the class name, plugin ID and title could be more clear about that
  2. The Scanner class name includes the word Scanner, but the Fixer and Solution class names don't include the words Fixer and Solution respectively
  3. The Scanner and Solution plugin IDs start with scanner_fixer_api_example_ but the Fixer plugin ID does not
  4. All three plugins could benefit from titles that start with Example:

Proposed resolution

  1. Rename \Drupal\scanner_fixer_api_example\Plugin\ScannerFixer\Fixer\TaxonomyIndexNode to \Drupal\scanner_fixer_api_example\Plugin\ScannerFixer\Fixer\TaxonomyBuildNodeIndexFixer
  2. Change the Fixer's plugin ID to scanner_fixer_api_example_taxonomy_build_node_index
  3. Change the Fixer's plugin title to Example: Build and insert taxonomy index entries for a node fixer
  4. Rename \Drupal\scanner_fixer_api_example\Plugin\ScannerFixer\Solution\RebuildTaxonomyIndex to \Drupal\scanner_fixer_api_example\Plugin\ScannerFixer\Solution\RebuildTaxonomyIndexSolution
  5. Change the Solution's plugin title to Example: Rebuild taxonomy index solution
  6. Change the Scanner's plugin title to Example: Published node scanner

Remaining tasks

  1. Write a patch
  2. Review and feedback
  3. RTBC and feedback
  4. Commit
  5. Release

User interface changes

None.

API changes

Class name changes. These would be considered backwards-compatibility breaks, but the module is in pre-release (alpha) so this is allowed.

Data model changes

None.

✨ Feature request
Status

Active

Version

2.0

Component

Code

Created by

🇨🇦Canada mparker17 UTC-4

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024