Issue #3015752 by alexpott, bnjmnm: Properly deprecate USERNAME_MAX_LENGTH and USER_REGISTER_* constants

Nathaniel Catchpole · Nathaniel Catchpole · commit 3cc8a612de9f · 2019-02-04T12:39:54.000Z
diff --git a/core/lib/Drupal/Core/Installer/Form/SiteConfigureForm.php b/core/lib/Drupal/Core/Installer/Form/SiteConfigureForm.php
@@ -9,6 +9,7 @@
 use Drupal\Core\Site\Settings;
 use Drupal\Core\State\StateInterface;
 use Drupal\user\UserStorageInterface;
+use Drupal\user\UserInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
@@ -178,7 +179,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
     $form['admin_account']['account']['name'] = [
       '#type' => 'textfield',
       '#title' => $this->t('Username'),
-      '#maxlength' => USERNAME_MAX_LENGTH,
+      '#maxlength' => UserInterface::USERNAME_MAX_LENGTH,
       '#description' => $this->t("Several special characters are allowed, including space, period (.), hyphen (-), apostrophe ('), underscore (_), and the @ sign."),
       '#required' => TRUE,
       '#attributes' => ['class' => ['username']],
diff --git a/core/modules/comment/src/CommentManager.php b/core/modules/comment/src/CommentManager.php
@@ -17,6 +17,7 @@
 use Drupal\field\Entity\FieldStorageConfig;
 use Drupal\field\Entity\FieldConfig;
 use Drupal\user\RoleInterface;
+use Drupal\user\UserInterface;
 
 /**
  * Comment manager contains common functions to manage comment fields.
@@ -174,7 +175,7 @@ public function forbiddenMessage(EntityInterface $entity, $field_name) {
         $destination = ['destination' => $entity->toUrl('canonical', ['fragment' => 'comment-form'])->toString()];
       }
 
-      if ($this->userConfig->get('register') != USER_REGISTER_ADMINISTRATORS_ONLY) {
+      if ($this->userConfig->get('register') != UserInterface::REGISTER_ADMINISTRATORS_ONLY) {
         // Users can register themselves.
         return $this->t('<a href=":login">Log in</a> or <a href=":register">register</a> to post comments', [
           ':login' => Url::fromRoute('user.login', [], ['query' => $destination])->toString(),
diff --git a/core/modules/user/src/Access/RegisterAccessCheck.php b/core/modules/user/src/Access/RegisterAccessCheck.php
@@ -5,6 +5,7 @@
 use Drupal\Core\Access\AccessResult;
 use Drupal\Core\Routing\Access\AccessInterface;
 use Drupal\Core\Session\AccountInterface;
+use Drupal\user\UserInterface;
 
 /**
  * Access check for user registration routes.
@@ -22,7 +23,7 @@ class RegisterAccessCheck implements AccessInterface {
    */
   public function access(AccountInterface $account) {
     $user_settings = \Drupal::config('user.settings');
-    return AccessResult::allowedIf($account->isAnonymous() && $user_settings->get('register') != USER_REGISTER_ADMINISTRATORS_ONLY)->cacheUntilConfigurationChanges($user_settings);
+    return AccessResult::allowedIf($account->isAnonymous() && $user_settings->get('register') != UserInterface::REGISTER_ADMINISTRATORS_ONLY)->cacheUntilConfigurationChanges($user_settings);
   }
 
 }
diff --git a/core/modules/user/src/AccountForm.php b/core/modules/user/src/AccountForm.php
@@ -104,7 +104,7 @@ public function form(array $form, FormStateInterface $form_state) {
     $form['account']['name'] = [
       '#type' => 'textfield',
       '#title' => $this->t('Username'),
-      '#maxlength' => USERNAME_MAX_LENGTH,
+      '#maxlength' => UserInterface::USERNAME_MAX_LENGTH,
       '#description' => $this->t("Several special characters are allowed, including space, period (.), hyphen (-), apostrophe ('), underscore (_), and the @ sign."),
       '#required' => TRUE,
       '#attributes' => [
@@ -184,7 +184,7 @@ public function form(array $form, FormStateInterface $form_state) {
       $status = $account->get('status')->value;
     }
     else {
-      $status = $config->get('register') == USER_REGISTER_VISITORS ? 1 : 0;
+      $status = $config->get('register') == UserInterface::REGISTER_VISITORS ? 1 : 0;
     }
 
     $form['account']['status'] = [
diff --git a/core/modules/user/src/AccountSettingsForm.php b/core/modules/user/src/AccountSettingsForm.php
@@ -151,9 +151,9 @@ public function buildForm(array $form, FormStateInterface $form_state) {
       '#title' => $this->t('Who can register accounts?'),
       '#default_value' => $config->get('register'),
       '#options' => [
-        USER_REGISTER_ADMINISTRATORS_ONLY => $this->t('Administrators only'),
-        USER_REGISTER_VISITORS => $this->t('Visitors'),
-        USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL => $this->t('Visitors, but administrator approval is required'),
+        UserInterface::REGISTER_ADMINISTRATORS_ONLY => $this->t('Administrators only'),
+        UserInterface::REGISTER_VISITORS => $this->t('Visitors'),
+        UserInterface::REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL => $this->t('Visitors, but administrator approval is required'),
       ],
     ];
     $form['registration_cancellation']['user_email_verification'] = [
@@ -203,7 +203,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
     $form['email_admin_created'] = [
       '#type' => 'details',
       '#title' => $this->t('Welcome (new user created by administrator)'),
-      '#open' => $config->get('register') == USER_REGISTER_ADMINISTRATORS_ONLY,
+      '#open' => $config->get('register') == UserInterface::REGISTER_ADMINISTRATORS_ONLY,
       '#description' => $this->t('Edit the welcome email messages sent to new member accounts created by an administrator.') . ' ' . $email_token_help,
       '#group' => 'email',
     ];
@@ -223,7 +223,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
     $form['email_pending_approval'] = [
       '#type' => 'details',
       '#title' => $this->t('Welcome (awaiting approval)'),
-      '#open' => $config->get('register') == USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL,
+      '#open' => $config->get('register') == UserInterface::REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL,
       '#description' => $this->t('Edit the welcome email messages sent to new members upon registering, when administrative approval is required.') . ' ' . $email_token_help,
       '#group' => 'email',
     ];
@@ -243,7 +243,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
     $form['email_pending_approval_admin'] = [
       '#type' => 'details',
       '#title' => $this->t('Admin (user awaiting approval)'),
-      '#open' => $config->get('register') == USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL,
+      '#open' => $config->get('register') == UserInterface::REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL,
       '#description' => $this->t('Edit the email notifying the site administrator that there are new members awaiting administrative approval.') . ' ' . $email_token_help,
       '#group' => 'email',
     ];
@@ -263,7 +263,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
     $form['email_no_approval_required'] = [
       '#type' => 'details',
       '#title' => $this->t('Welcome (no approval required)'),
-      '#open' => $config->get('register') == USER_REGISTER_VISITORS,
+      '#open' => $config->get('register') == UserInterface::REGISTER_VISITORS,
       '#description' => $this->t('Edit the welcome email messages sent to new members upon registering, when no administrator approval is required.') . ' ' . $email_token_help,
       '#group' => 'email',
     ];
diff --git a/core/modules/user/src/Form/UserLoginForm.php b/core/modules/user/src/Form/UserLoginForm.php
@@ -7,6 +7,7 @@
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Render\RendererInterface;
 use Drupal\user\UserAuthInterface;
+use Drupal\user\UserInterface;
 use Drupal\user\UserStorageInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
@@ -94,7 +95,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
       '#type' => 'textfield',
       '#title' => $this->t('Username'),
       '#size' => 60,
-      '#maxlength' => USERNAME_MAX_LENGTH,
+      '#maxlength' => UserInterface::USERNAME_MAX_LENGTH,
       '#description' => $this->t('Enter your @s username.', ['@s' => $config->get('name')]),
       '#required' => TRUE,
       '#attributes' => [
diff --git a/core/modules/user/src/Form/UserPasswordForm.php b/core/modules/user/src/Form/UserPasswordForm.php
@@ -6,6 +6,7 @@
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Language\LanguageManagerInterface;
 use Drupal\Core\Render\Element\Email;
+use Drupal\user\UserInterface;
 use Drupal\user\UserStorageInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
@@ -68,7 +69,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
       '#type' => 'textfield',
       '#title' => $this->t('Username or email address'),
       '#size' => 60,
-      '#maxlength' => max(USERNAME_MAX_LENGTH, Email::EMAIL_MAX_LENGTH),
+      '#maxlength' => max(UserInterface::USERNAME_MAX_LENGTH, Email::EMAIL_MAX_LENGTH),
       '#required' => TRUE,
       '#attributes' => [
         'autocorrect' => 'off',
diff --git a/core/modules/user/src/Plugin/Block/UserLoginBlock.php b/core/modules/user/src/Plugin/Block/UserLoginBlock.php
@@ -9,6 +9,7 @@
 use Drupal\Core\Url;
 use Drupal\Core\Session\AccountInterface;
 use Drupal\Core\Block\BlockBase;
+use Drupal\user\UserInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
@@ -111,7 +112,7 @@ public function build() {
 
     // Build action links.
     $items = [];
-    if (\Drupal::config('user.settings')->get('register') != USER_REGISTER_ADMINISTRATORS_ONLY) {
+    if (\Drupal::config('user.settings')->get('register') != UserInterface::REGISTER_ADMINISTRATORS_ONLY) {
       $items['create_account'] = [
         '#type' => 'link',
         '#title' => $this->t('Create new account'),
diff --git a/core/modules/user/src/Plugin/Validation/Constraint/UserNameConstraintValidator.php b/core/modules/user/src/Plugin/Validation/Constraint/UserNameConstraintValidator.php
@@ -2,6 +2,7 @@
 
 namespace Drupal\user\Plugin\Validation\Constraint;
 
+use Drupal\user\UserInterface;
 use Symfony\Component\Validator\Constraint;
 use Symfony\Component\Validator\ConstraintValidator;
 
@@ -52,8 +53,8 @@ public function validate($items, Constraint $constraint) {
     ) {
       $this->context->addViolation($constraint->illegalMessage);
     }
-    if (mb_strlen($name) > USERNAME_MAX_LENGTH) {
-      $this->context->addViolation($constraint->tooLongMessage, ['%name' => $name, '%max' => USERNAME_MAX_LENGTH]);
+    if (mb_strlen($name) > UserInterface::USERNAME_MAX_LENGTH) {
+      $this->context->addViolation($constraint->tooLongMessage, ['%name' => $name, '%max' => UserInterface::USERNAME_MAX_LENGTH]);
     }
   }
 
diff --git a/core/modules/user/src/Plugin/migrate/destination/EntityUser.php b/core/modules/user/src/Plugin/migrate/destination/EntityUser.php
@@ -11,6 +11,7 @@
 use Drupal\migrate\Plugin\MigrationInterface;
 use Drupal\migrate\Plugin\migrate\destination\EntityContentBase;
 use Drupal\migrate\Row;
+use Drupal\user\UserInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
@@ -167,8 +168,8 @@ protected function processStubRow(Row $row) {
     if (is_array($name)) {
       $name = reset($name);
     }
-    if (mb_strlen($name) > USERNAME_MAX_LENGTH) {
-      $row->setDestinationProperty('name', mb_substr($name, 0, USERNAME_MAX_LENGTH));
+    if (mb_strlen($name) > UserInterface::USERNAME_MAX_LENGTH) {
+      $row->setDestinationProperty('name', mb_substr($name, 0, UserInterface::USERNAME_MAX_LENGTH));
     }
   }
 
diff --git a/core/modules/user/src/Plugin/rest/resource/UserRegistrationResource.php b/core/modules/user/src/Plugin/rest/resource/UserRegistrationResource.php
@@ -102,7 +102,7 @@ public function post(UserInterface $account = NULL) {
 
     // Only activate new users if visitors are allowed to register and no email
     // verification required.
-    if ($this->userSettings->get('register') == USER_REGISTER_VISITORS && !$this->userSettings->get('verify_mail')) {
+    if ($this->userSettings->get('register') == UserInterface::REGISTER_VISITORS && !$this->userSettings->get('verify_mail')) {
       $account->activate();
     }
     else {
@@ -147,7 +147,7 @@ protected function ensureAccountCanRegister(UserInterface $account = NULL) {
     }
 
     // Verify that the current user can register a user account.
-    if ($this->userSettings->get('register') == USER_REGISTER_ADMINISTRATORS_ONLY) {
+    if ($this->userSettings->get('register') == UserInterface::REGISTER_ADMINISTRATORS_ONLY) {
       throw new AccessDeniedHttpException('You cannot register a new user account.');
     }
 
@@ -175,14 +175,14 @@ protected function ensureAccountCanRegister(UserInterface $account = NULL) {
   protected function sendEmailNotifications(UserInterface $account) {
     $approval_settings = $this->userSettings->get('register');
     // No e-mail verification is required. Activating the user.
-    if ($approval_settings == USER_REGISTER_VISITORS) {
+    if ($approval_settings == UserInterface::REGISTER_VISITORS) {
       if ($this->userSettings->get('verify_mail')) {
         // No administrator approval required.
         _user_mail_notify('register_no_approval_required', $account);
       }
     }
     // Administrator approval required.
-    elseif ($approval_settings == USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL) {
+    elseif ($approval_settings == UserInterface::REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL) {
       _user_mail_notify('register_pending_approval', $account);
     }
   }
diff --git a/core/modules/user/src/UserStorageSchema.php b/core/modules/user/src/UserStorageSchema.php
@@ -51,7 +51,7 @@ protected function getSharedTableFieldSchema(FieldStorageDefinitionInterface $st
           $schema['fields'][$field_name]['not null'] = TRUE;
           // Make sure the field is no longer than 191 characters so we can
           // add a unique constraint in MySQL.
-          $schema['fields'][$field_name]['length'] = USERNAME_MAX_LENGTH;
+          $schema['fields'][$field_name]['length'] = UserInterface::USERNAME_MAX_LENGTH;
           break;
 
         case 'mail':
diff --git a/core/modules/user/tests/src/Functional/RestRegisterUserTest.php b/core/modules/user/tests/src/Functional/RestRegisterUserTest.php
@@ -5,8 +5,9 @@
 use Drupal\Core\Url;
 use Drupal\Tests\rest\Functional\CookieResourceTestTrait;
 use Drupal\Tests\rest\Functional\ResourceTestBase;
-use GuzzleHttp\RequestOptions;
 use Drupal\Core\Test\AssertMailTrait;
+use Drupal\user\UserInterface;
+use GuzzleHttp\RequestOptions;
 
 /**
  * Tests user registration via REST resource.
@@ -70,7 +71,7 @@ public function testRegisterUser() {
 
     // Test out different setting User Registration and Email Verification.
     // Allow visitors to register with no email verification.
-    $config->set('register', USER_REGISTER_VISITORS);
+    $config->set('register', UserInterface::REGISTER_VISITORS);
     $config->set('verify_mail', 0);
     $config->save();
     $user = $this->registerUser('Palmer.Eldritch');
@@ -85,14 +86,14 @@ public function testRegisterUser() {
     $this->assertResourceErrorResponse(422, "No password provided.", $response);
 
     // Attempt to register with a password when e-mail verification is on.
-    $config->set('register', USER_REGISTER_VISITORS);
+    $config->set('register', UserInterface::REGISTER_VISITORS);
     $config->set('verify_mail', 1);
     $config->save();
     $response = $this->registerRequest('Estraven', TRUE);
     $this->assertResourceErrorResponse(422, 'A Password cannot be specified. It will be generated on login.', $response);
 
     // Allow visitors to register with email verification.
-    $config->set('register', USER_REGISTER_VISITORS);
+    $config->set('register', UserInterface::REGISTER_VISITORS);
     $config->set('verify_mail', 1);
     $config->save();
     $name = 'Jason.Taverner';
@@ -104,7 +105,7 @@ public function testRegisterUser() {
     $this->assertMailString('body', 'You may now log in by clicking this link', 1);
 
     // Allow visitors to register with Admin approval and no email verification.
-    $config->set('register', USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL);
+    $config->set('register', UserInterface::REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL);
     $config->set('verify_mail', 0);
     $config->save();
     $name = 'Argaven';
@@ -116,7 +117,7 @@ public function testRegisterUser() {
     $this->assertMailString('body', 'Argaven has applied for an account', 2);
 
     // Allow visitors to register with Admin approval and e-mail verification.
-    $config->set('register', USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL);
+    $config->set('register', UserInterface::REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL);
     $config->set('verify_mail', 1);
     $config->save();
     $name = 'Bob.Arctor';
diff --git a/core/modules/user/tests/src/Functional/UserAdminTest.php b/core/modules/user/tests/src/Functional/UserAdminTest.php
@@ -5,6 +5,7 @@
 use Drupal\Core\Test\AssertMailTrait;
 use Drupal\Tests\BrowserTestBase;
 use Drupal\user\RoleInterface;
+use Drupal\user\UserInterface;
 
 /**
  * Tests user administration page functionality.
@@ -167,7 +168,7 @@ public function testNotificationEmailAddress() {
     // Allow users to register with admin approval.
     $config
       ->set('verify_mail', TRUE)
-      ->set('register', USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL)
+      ->set('register', UserInterface::REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL)
       ->save();
     // Set the site and notification email addresses.
     $system = $this->config('system.site');
diff --git a/core/modules/user/tests/src/Functional/UserEditedOwnAccountTest.php b/core/modules/user/tests/src/Functional/UserEditedOwnAccountTest.php
@@ -3,6 +3,7 @@
 namespace Drupal\Tests\user\Functional;
 
 use Drupal\Tests\BrowserTestBase;
+use Drupal\user\UserInterface;
 
 /**
  * Tests user edited own account can still log in.
@@ -14,7 +15,7 @@ class UserEditedOwnAccountTest extends BrowserTestBase {
   public function testUserEditedOwnAccount() {
     // Change account setting 'Who can register accounts?' to Administrators
     // only.
-    $this->config('user.settings')->set('register', USER_REGISTER_ADMINISTRATORS_ONLY)->save();
+    $this->config('user.settings')->set('register', UserInterface::REGISTER_ADMINISTRATORS_ONLY)->save();
 
     // Create a new user account and log in.
     $account = $this->drupalCreateUser(['change own username']);
diff --git a/core/modules/user/tests/src/Functional/UserRegistrationTest.php b/core/modules/user/tests/src/Functional/UserRegistrationTest.php
diff --git a/core/modules/user/tests/src/Kernel/Migrate/d6/MigrateUserConfigsTest.php b/core/modules/user/tests/src/Kernel/Migrate/d6/MigrateUserConfigsTest.php
diff --git a/core/modules/user/tests/src/Kernel/UserValidationTest.php b/core/modules/user/tests/src/Kernel/UserValidationTest.php
diff --git a/core/modules/user/tests/src/Unit/UserRegistrationResourceTest.php b/core/modules/user/tests/src/Unit/UserRegistrationResourceTest.php
diff --git a/core/profiles/minimal/tests/src/Functional/MinimalTest.php b/core/profiles/minimal/tests/src/Functional/MinimalTest.php

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`use Drupal\Core\Access\AccessResult;`
`6`	`6`	`use Drupal\Core\Routing\Access\AccessInterface;`
`7`	`7`	`use Drupal\Core\Session\AccountInterface;`
	`8`	`+use Drupal\user\UserInterface;`
`8`	`9`
`9`	`10`	`/**`
`10`	`11`	`* Access check for user registration routes.`
`@@ -22,7 +23,7 @@ class RegisterAccessCheck implements AccessInterface {`
`22`	`23`	`*/`
`23`	`24`	`public function access(AccountInterface $account) {`
`24`	`25`	`$user_settings = \Drupal::config('user.settings');`
`25`		`- return AccessResult::allowedIf($account->isAnonymous() && $user_settings->get('register') != USER_REGISTER_ADMINISTRATORS_ONLY)->cacheUntilConfigurationChanges($user_settings);`
	`26`	`+ return AccessResult::allowedIf($account->isAnonymous() && $user_settings->get('register') != UserInterface::REGISTER_ADMINISTRATORS_ONLY)->cacheUntilConfigurationChanges($user_settings);`
`26`	`27`	`}`
`27`	`28`
`28`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace Drupal\user\Plugin\Validation\Constraint;`
`4`	`4`
	`5`	`+use Drupal\user\UserInterface;`
`5`	`6`	`use Symfony\Component\Validator\Constraint;`
`6`	`7`	`use Symfony\Component\Validator\ConstraintValidator;`
`7`	`8`
`@@ -52,8 +53,8 @@ public function validate($items, Constraint $constraint) {`
`52`	`53`	`) {`
`53`	`54`	`$this->context->addViolation($constraint->illegalMessage);`
`54`	`55`	`}`
`55`		`- if (mb_strlen($name) > USERNAME_MAX_LENGTH) {`
`56`		`- $this->context->addViolation($constraint->tooLongMessage, ['%name' => $name, '%max' => USERNAME_MAX_LENGTH]);`
	`56`	`+ if (mb_strlen($name) > UserInterface::USERNAME_MAX_LENGTH) {`
	`57`	`+ $this->context->addViolation($constraint->tooLongMessage, ['%name' => $name, '%max' => UserInterface::USERNAME_MAX_LENGTH]);`
`57`	`58`	`}`
`58`	`59`	`}`
`59`	`60`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`	`use Drupal\migrate\Plugin\MigrationInterface;`
`12`	`12`	`use Drupal\migrate\Plugin\migrate\destination\EntityContentBase;`
`13`	`13`	`use Drupal\migrate\Row;`
	`14`	`+use Drupal\user\UserInterface;`
`14`	`15`	`use Symfony\Component\DependencyInjection\ContainerInterface;`
`15`	`16`
`16`	`17`	`/**`
`@@ -167,8 +168,8 @@ protected function processStubRow(Row $row) {`
`167`	`168`	`if (is_array($name)) {`
`168`	`169`	`$name = reset($name);`
`169`	`170`	`}`
`170`		`- if (mb_strlen($name) > USERNAME_MAX_LENGTH) {`
`171`		`- $row->setDestinationProperty('name', mb_substr($name, 0, USERNAME_MAX_LENGTH));`
	`171`	`+ if (mb_strlen($name) > UserInterface::USERNAME_MAX_LENGTH) {`
	`172`	`+ $row->setDestinationProperty('name', mb_substr($name, 0, UserInterface::USERNAME_MAX_LENGTH));`
`172`	`173`	`}`
`173`	`174`	`}`
`174`	`175`