Use attributes instead of annotations

TODO:

Delete the annotation class src/Annotation/Sitemap.php once annotations are no longer supported.
Add a note for developers to update their plugins after the change to use the attribute instead of the annotation.

@berramou, thank you for the excellent contributions! The code is clear, it makes good use of APIs, and doesn't miss anything as far as I can tell. Manual testing shows everything working as far as I can tell. I don't think this needs any new tests, because the existing tests cover the changes (and they all pass!).

I've rebased this onto 8.x-2.x.

Quick question before I merge this: I noticed that in some annotations in core (for example, in the handlers sub-array of the ConfigEntityType annotation on \Drupal\block\Entity\Block), references to other classes in annotations are done with the special ::class constant... should we also do that for Sitemap's deriver annotation-keys in the following places?

1. modules/sitemap_book/src/Plugin/Sitemap/Book.php,
2. src/Plugin/Sitemap/Menu.php,
3. src/Plugin/Sitemap/Vocabulary.php, and
4. tests/modules/sitemap_custom_plugin_test/src/Plugin/Sitemap/DerivativeSitemapPlugin.php

... for example, in src/Plugin/Sitemap/Menu.php, should we modify the code as follows...

 use Drupal\sitemap\Attribute\Sitemap;
+use Drupal\sitemap\Plugin\Derivative\MenuSitemapDeriver;
 use Drupal\sitemap\SitemapBase;
 /*...*/
 #[Sitemap(
   /*...*/
-  deriver: "Drupal\sitemap\Plugin\Derivative\MenuSitemapDeriver",
+  deriver: MenuSitemapDeriver::class,
   menu: "",
 )]

Hello @mparker17, thanks for the review and the rebase.

You're absolutely right — since we're using attributes and targeting PHP 8+, it's preferable to use ::class for:

- IDE autocompletion
- Refactoring safety
- Compile-time class existence checks

Speaking of PHP versions and attributes, I think it's best to explicitly add a PHP requirement (>=8.1) in composer.json.
As the module is compatible with ^10.2 || ^11 of Drupal, and Drupal 10.2+ requires PHP 8.1+, this makes sense and keeps things clear.

Speaking of PHP versions and attributes, I think it's best to explicitly add a PHP requirement (>=8.1) in composer.json.

Makes sense: I've done that in the latest commit.

I expected the Drupal.org Composer Service (façade) a.k.a. project_composer → to update composer.json with a PHP version to match what's in sitemap.info.yml, but to my surprise, I couldn't find any code to do that, so I updated both composer.json and sitemap.info.yml.

If tests pass, then I'm going to merge this. Thanks!

Marked as Fixed.

Updated the issue summary with more information, for users of the module who are interested in the change when they find it in the release notes.

Thank @mparker17 for your contributions.

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

I discovered that using the new keyword in the PHP annotations (i.e.: title: new TranslatableMarkup(...)) actually introduced an unstated dependency on PHP 8.1!

I've created a follow-up issue, 🐛 Unstated dependency on PHP 8.1 Active — see that one for more details.

Quick update: the changes in this issue have been released in version 8.x-2.1 → .

thank you @mparker17 for the release!