From 096d522800655e369f8b0e624cf7d31f3efb05e0 Mon Sep 17 00:00:00 2001 From: "Theresa.Grannum" <theresa.grannum@3688861.no-reply.drupal.org> Date: Thu, 19 May 2022 20:25:34 +0000 Subject: [PATCH] Issue #3281405 by Theresa.Grannum: Add @internal to Automatic Updates validator classes --- src/Validator/CronFrequencyValidator.php | 4 ++++ src/Validator/InstalledVersionValidator.php | 4 ++++ src/Validator/PackageManagerReadinessCheck.php | 4 ++++ src/Validator/SettingsValidator.php | 5 +++++ src/Validator/StagedDatabaseUpdateValidator.php | 4 ++++ src/Validator/StagedProjectsValidator.php | 4 ++++ src/Validator/UpdateReleaseValidator.php | 4 ++++ src/Validator/XdebugValidator.php | 4 ++++ 8 files changed, 33 insertions(+) diff --git a/src/Validator/CronFrequencyValidator.php b/src/Validator/CronFrequencyValidator.php index 4003a7273e..e431158047 100644 --- a/src/Validator/CronFrequencyValidator.php +++ b/src/Validator/CronFrequencyValidator.php @@ -15,6 +15,10 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface; /** * Validates that cron runs frequently enough to perform automatic updates. + * + * @internal + * This class is an internal part of the module's update handling and + * should not be used by external code. */ class CronFrequencyValidator implements EventSubscriberInterface { diff --git a/src/Validator/InstalledVersionValidator.php b/src/Validator/InstalledVersionValidator.php index abb30dc612..0a827de58b 100644 --- a/src/Validator/InstalledVersionValidator.php +++ b/src/Validator/InstalledVersionValidator.php @@ -13,6 +13,10 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface; /** * Validates that the site can update from the installed version of Drupal. + * + * @internal + * This class is an internal part of the module's update handling and + * should not be used by external code. */ class InstalledVersionValidator implements EventSubscriberInterface { diff --git a/src/Validator/PackageManagerReadinessCheck.php b/src/Validator/PackageManagerReadinessCheck.php index 1a6bb48a80..960e97b2ea 100644 --- a/src/Validator/PackageManagerReadinessCheck.php +++ b/src/Validator/PackageManagerReadinessCheck.php @@ -12,6 +12,10 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface; * This class exists to facilitate re-use of Package Manager's stage validators * during update readiness checks, in addition to whatever events they normally * subscribe to. + * + * @internal + * This class is an internal part of the module's update handling and + * should not be used by external code. */ class PackageManagerReadinessCheck implements EventSubscriberInterface { diff --git a/src/Validator/SettingsValidator.php b/src/Validator/SettingsValidator.php index 4d09e58df7..6da6f14f32 100644 --- a/src/Validator/SettingsValidator.php +++ b/src/Validator/SettingsValidator.php @@ -11,6 +11,11 @@ use Drupal\package_manager\Event\PreCreateEvent; use Drupal\package_manager\Event\PreOperationStageEvent; use Symfony\Component\EventDispatcher\EventSubscriberInterface; +/** + * @internal + * This class is an internal part of the module's update handling and + * should not be used by external code. + */ class SettingsValidator implements EventSubscriberInterface { use StringTranslationTrait; diff --git a/src/Validator/StagedDatabaseUpdateValidator.php b/src/Validator/StagedDatabaseUpdateValidator.php index 45e55b07c2..3c1cedd9d8 100644 --- a/src/Validator/StagedDatabaseUpdateValidator.php +++ b/src/Validator/StagedDatabaseUpdateValidator.php @@ -14,6 +14,10 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface; /** * Validates that there are no database updates in a staged update. + * + * @internal + * This class is an internal part of the module's update handling and + * should not be used by external code. */ class StagedDatabaseUpdateValidator implements EventSubscriberInterface { diff --git a/src/Validator/StagedProjectsValidator.php b/src/Validator/StagedProjectsValidator.php index eec9e8f9fb..44e130bf30 100644 --- a/src/Validator/StagedProjectsValidator.php +++ b/src/Validator/StagedProjectsValidator.php @@ -11,6 +11,10 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface; /** * Validates the staged Drupal projects. + * + * @internal + * This class is an internal part of the module's update handling and + * should not be used by external code. */ final class StagedProjectsValidator implements EventSubscriberInterface { diff --git a/src/Validator/UpdateReleaseValidator.php b/src/Validator/UpdateReleaseValidator.php index d501d1cda7..97449b36d3 100644 --- a/src/Validator/UpdateReleaseValidator.php +++ b/src/Validator/UpdateReleaseValidator.php @@ -10,6 +10,10 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface; /** * Validates that the target release of Drupal core is secure and supported. + * + * @internal + * This class is an internal part of the module's update handling and + * should not be used by external code. */ class UpdateReleaseValidator implements EventSubscriberInterface { diff --git a/src/Validator/XdebugValidator.php b/src/Validator/XdebugValidator.php index 098dc33481..95551c5f55 100644 --- a/src/Validator/XdebugValidator.php +++ b/src/Validator/XdebugValidator.php @@ -8,6 +8,10 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface; /** * Flags a warning if Xdebug is enabled. + * + * @internal + * This class is an internal part of the module's update handling and + * should not be used by external code. */ class XdebugValidator implements EventSubscriberInterface { -- GitLab