CS cleanups, remove t() from tests and otherwise, some test cleanups

Author: paul-m

ajax_example/ajax_example.routing.yml

@@ -91,6 +91,6 @@ ajax_example.autocomplete_user:
   path: '/examples/ajax_example/user_autocomplete'
   defaults:
     _form: '\Drupal\ajax_example\Form\EntityAutocomplete'
-    _title: 'Autocomplete users with entity_autocomplete.'
+    _title: 'Autocomplete users with entity_autocomplete'
   requirements:
     _permission: 'access content'

ajax_example/src/Form/DynamicFormSections.php

@@ -60,7 +60,7 @@ public function buildForm(array $form, FormStateInterface $form_state, $nojs = N
     $form['question_type_select'] = [
       // This is our select dropdown.
       '#type' => 'select',
-      '#title' => t('Question style'),
+      '#title' => $this->t('Question style'),
       // We have a variety of form items you can use to get input from the user.
       '#options' => [
         'Choose question style' => 'Choose question style',
@@ -80,7 +80,7 @@ public function buildForm(array $form, FormStateInterface $form_state, $nojs = N
     // The CSS for this module hides this next button if JS is enabled.
     $form['question_type_submit'] = [
       '#type' => 'submit',
-      '#value' => t('Choose'),
+      '#value' => $this->t('Choose'),
       '#attributes' => ['class' => ['ajax-example-inline']],
       // No need to validate when submitting this.
       '#limit_validation_errors' => [],
@@ -117,7 +117,7 @@ public function buildForm(array $form, FormStateInterface $form_state, $nojs = N
     if (!empty($question_type) && $question_type !== 'Choose question style') {
 
       $form['questions_fieldset']['question'] = [
-        '#markup' => t('Who was the first president of the U.S.?'),
+        '#markup' => $this->t('Who was the first president of the U.S.?'),
       ];
 
       // Build up a secondary form, based on the type of question the user
@@ -126,7 +126,7 @@ public function buildForm(array $form, FormStateInterface $form_state, $nojs = N
         case 'Multiple Choice':
           $form['questions_fieldset']['question'] = [
             '#type' => 'radios',
-            '#title' => t('Who was the first president of the United States'),
+            '#title' => $this->t('Who was the first president of the United States'),
             '#options' => [
               'George Bush' => 'George Bush',
               'Adam McGuire' => 'Adam McGuire',

ajax_example/src/Form/EntityAutocomplete.php

@@ -69,9 +69,7 @@ public function getFormId() {
    */
   public function buildForm(array $form, FormStateInterface $form_state) {
     $form['info'] = [
-      '#markup' => '<div>' . t("This example uses the entity_autocomplete form "
-        . "element to select users. You'll need a few users on your system for "
-        . "it to make sense.") . '</div>',
+      '#markup' => '<div>' . $this->t("This example uses the <code>entity_autocomplete</code> form element to select users. You'll need a few users on your system for it to make sense.") . '</div>',
     ];
 
     // Here we use the delightful entity_autocomplete form element. It allows us
@@ -85,7 +83,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
       // Specifying #tags as TRUE allows for multiple selections, separated by
       // commas.
       '#tags' => TRUE,
-      '#title' => t('Choose a user. Separate with commas.'),
+      '#title' => $this->t('Choose a user (Separate with commas)'),
     ];
 
     $form['actions'] = [

ajax_example/src/Form/Wizard.php

@@ -37,7 +37,7 @@ public function buildForm(array $form, FormStateInterface $form_state, $no_js_us
     // We want to deal with hierarchical form values.
     $form['#tree'] = TRUE;
     $form['description'] = [
-      '#markup' => t('This example is a step-by-step wizard. The @link does it without page reloads; the @link1 is the same code but simulates a non-javascript environment, showing it with page reloads.', [
+      '#markup' => $this->t('This example is a step-by-step wizard. The @link does it without page reloads; the @link1 is the same code but simulates a non-javascript environment, showing it with page reloads.', [
         '@link' => $linktwo,
         '@link1' => $link,
       ]),
@@ -155,7 +155,7 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
           unset($form['next']);
           $form['step2'] = [
             '#type' => 'fieldset',
-            '#title' => t('Step 2: Street address info'),
+            '#title' => $this->t('Step 2: Street address info'),
           ];
           $form['step2']['address'] = [
             '#type' => 'textfield',
@@ -197,7 +197,7 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
       if ($step > 1 && !isset($form['prev'])) {
         $form['prev'] = [
           '#type' => 'submit',
-          '#value' => t("Previous step"),
+          '#value' => $this->t("Previous step"),
           // Since all info will be discarded, don't validate on 'prev'.
           '#limit_validation_errors' => [],
           // #submit is required to use #limit_validation_errors.

batch_example/src/Form/BatchExampleForm.php

@@ -24,14 +24,14 @@ public function buildForm(array $form, FormStateInterface $form_state) {
 
     $form['description'] = [
       '#type' => 'markup',
-      '#markup' => t('This example offers two different batches. The first does 1000 identical operations, each completed in on run; the second does 20 operations, but each takes more than one run to operate if there are more than 5 nodes.'),
+      '#markup' => $this->t('This example offers two different batches. The first does 1000 identical operations, each completed in on run; the second does 20 operations, but each takes more than one run to operate if there are more than 5 nodes.'),
     ];
     $form['batch'] = [
       '#type' => 'select',
       '#title' => 'Choose batch',
       '#options' => [
-        'batch_1' => t('batch 1 - 1000 operations'),
-        'batch_2' => t('batch 2 - 20 operations.'),
+        'batch_1' => $this->t('batch 1 - 1000 operations'),
+        'batch_2' => $this->t('batch 2 - 20 operations.'),
       ],
     ];
     $form['submit'] = [
@@ -93,12 +93,12 @@ public function generateBatch1() {
         'batch_example_op_1',
         [
           $i + 1,
-          t('(Operation @operation)', ['@operation' => $i]),
+          $this->t('(Operation @operation)', ['@operation' => $i]),
         ],
       ];
     }
     $batch = [
-      'title' => t('Creating an array of @num operations', ['@num' => $num_operations]),
+      'title' => $this->t('Creating an array of @num operations', ['@num' => $num_operations]),
       'operations' => $operations,
       'finished' => 'batch_example_finished',
     ];
@@ -123,7 +123,7 @@ public function generateBatch2() {
     for ($i = 0; $i < $num_operations; $i++) {
       $operations[] = [
         'batch_example_op_2',
-        [t('(Operation @operation)', ['@operation' => $i])],
+        [$this->t('(Operation @operation)', ['@operation' => $i])],
       ];
     }
     $batch = [
@@ -137,10 +137,10 @@ public function generateBatch2() {
       // operations, so @total will always be 20, even though there are multiple
       // nodes per operation.
       // Defaults to t('Completed @current of @total.').
-      'title' => t('Processing batch 2'),
-      'init_message' => t('Batch 2 is starting.'),
-      'progress_message' => t('Processed @current out of @total.'),
-      'error_message' => t('Batch 2 has encountered an error.'),
+      'title' => $this->t('Processing batch 2'),
+      'init_message' => $this->t('Batch 2 is starting.'),
+      'progress_message' => $this->t('Processed @current out of @total.'),
+      'error_message' => $this->t('Batch 2 has encountered an error.'),
     ];
     return $batch;
   }

block_example/src/Plugin/Block/ExampleUppercaseBlock.php

@@ -19,7 +19,7 @@ class ExampleUppercaseBlock extends BlockBase {
    */
   public function build() {
     return [
-      '#markup' => t("This block's title is changed to uppercase. Any block title which contains 'uppercase' will also be changed to uppercase."),
+      '#markup' => $this->t("This block's title is changed to uppercase. Any block title which contains 'uppercase' will also be changed to uppercase."),
     ];
   }
 

content_entity_example/tests/src/Functional/ContentEntityExampleTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Drupal\content_entity_example\Tests;
+namespace Drupal\Tests\content_entity_example\Functional;
 
 use Drupal\content_entity_example\Entity\Contact;
 use Drupal\Tests\examples\Functional\ExamplesBrowserTestBase;
@@ -35,19 +35,19 @@ public function testContentEntityExample() {
     ]);
 
     // Anonymous User should not see the link to the listing.
-    $assert->pageTextNotContains('Content Entity Example: Contacts Listing');
+    $assert->pageTextNotContains('Content Entity Example: Contacts listing');
 
     $this->drupalLogin($web_user);
 
     // Web_user user has the right to view listing.
-    $assert->linkExists('Content Entity Example: Contacts Listing');
+    $assert->linkExists('Content Entity Example: Contacts listing');
 
-    $this->clickLink('Content Entity Example: Contacts Listing');
+    $this->clickLink('Content Entity Example: Contacts listing');
 
     // WebUser can add entity content.
-    $assert->linkExists('Add Contact');
+    $assert->linkExists('Add contact');
 
-    $this->clickLink(t('Add Contact'));
+    $this->clickLink(t('Add contact'));
 
     $assert->fieldValueEquals('name[0][value]', '');
     $assert->fieldValueEquals('name[0][value]', '');
@@ -77,7 +77,7 @@ public function testContentEntityExample() {
     $assert->pageTextContains('test first name');
     $assert->pageTextContains('administrator');
     $assert->pageTextContains('male');
-    $assert->linkExists('Add Contact');
+    $assert->linkExists('Add contact');
     $assert->linkExists('Edit');
     $assert->linkExists('Delete');
 
@@ -109,14 +109,12 @@ public function testPaths() {
     $assert = $this->assertSession();
 
     // Generate a contact so that we can test the paths against it.
-    $contact = Contact::create(
-      [
-        'name' => 'somename',
-        'first_name' => 'Joe',
-        'gender' => 'female',
-        'role' => 'administrator',
-      ]
-    );
+    $contact = Contact::create([
+      'name' => 'somename',
+      'first_name' => 'Joe',
+      'gender' => 'female',
+      'role' => 'administrator',
+    ]);
     $contact->save();
 
     // Gather the test data.

dbtng_example/src/Controller/DbtngExampleController.php

@@ -21,7 +21,13 @@ public function entryList() {
     ];
 
     $rows = [];
-    $headers = [t('Id'), t('uid'), t('Name'), t('Surname'), t('Age')];
+    $headers = [
+      $this->t('Id'),
+      $this->t('uid'),
+      $this->t('Name'),
+      $this->t('Surname'),
+      $this->t('Age'),
+    ];
 
     foreach ($entries = DbtngExampleStorage::load() as $entry) {
       // Sanitize each entry.
@@ -31,7 +37,7 @@ public function entryList() {
       '#type' => 'table',
       '#header' => $headers,
       '#rows' => $rows,
-      '#empty' => t('No entries available.'),
+      '#empty' => $this->t('No entries available.'),
     ];
     // Don't cache this page.
     $content['#cache']['max-age'] = 0;
@@ -46,16 +52,15 @@ public function entryAdvancedList() {
     $content = [];
 
     $content['message'] = [
-      '#markup' => $this->t('A more complex list of entries in the database.') . ' ' .
-      $this->t('Only the entries with name = "John" and age older than 18 years are shown, the username of the person who created the entry is also shown.'),
+      '#markup' => $this->t('A more complex list of entries in the database. Only the entries with name = "John" and age older than 18 years are shown, the username of the person who created the entry is also shown.'),
     ];
 
     $headers = [
-      t('Id'),
-      t('Created by'),
-      t('Name'),
-      t('Surname'),
-      t('Age'),
+      $this->t('Id'),
+      $this->t('Created by'),
+      $this->t('Name'),
+      $this->t('Surname'),
+      $this->t('Age'),
     ];
 
     $rows = [];
@@ -68,7 +73,7 @@ public function entryAdvancedList() {
       '#header' => $headers,
       '#rows' => $rows,
       '#attributes' => ['id' => 'dbtng-example-advanced-list'],
-      '#empty' => t('No entries available.'),
+      '#empty' => $this->t('No entries available.'),
     ];
     // Don't cache this page.
     $content['#cache']['max-age'] = 0;

dbtng_example/src/Form/DbtngExampleUpdateForm.php

@@ -36,14 +36,14 @@ public function buildForm(array $form, FormStateInterface $form_state) {
     // Tell the user if there is nothing to display.
     if (empty($entries)) {
       $form['no_values'] = [
-        '#value' => t('No entries exist in the table dbtng_example table.'),
+        '#value' => $this->t('No entries exist in the table dbtng_example table.'),
       ];
       return $form;
     }
 
     $keyed_entries = [];
     foreach ($entries as $entry) {
-      $options[$entry->pid] = t('@pid: @name @surname (@age)', [
+      $options[$entry->pid] = $this->t('@pid: @name @surname (@age)', [
         '@pid' => $entry->pid,
         '@name' => $entry->name,
         '@surname' => $entry->surname,
@@ -64,7 +64,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
     $form['pid'] = [
       '#type' => 'select',
       '#options' => $options,
-      '#title' => t('Choose entry to update'),
+      '#title' => $this->t('Choose entry to update'),
       '#default_value' => $default_entry->pid,
       '#ajax' => [
         'wrapper' => 'updateform',
@@ -74,28 +74,28 @@ public function buildForm(array $form, FormStateInterface $form_state) {
 
     $form['name'] = [
       '#type' => 'textfield',
-      '#title' => t('Updated first name'),
+      '#title' => $this->t('Updated first name'),
       '#size' => 15,
       '#default_value' => $default_entry->name,
     ];
 
     $form['surname'] = [
       '#type' => 'textfield',
-      '#title' => t('Updated last name'),
+      '#title' => $this->t('Updated last name'),
       '#size' => 15,
       '#default_value' => $default_entry->surname,
     ];
     $form['age'] = [
       '#type' => 'textfield',
-      '#title' => t('Updated age'),
+      '#title' => $this->t('Updated age'),
       '#size' => 4,
       '#default_value' => $default_entry->age,
-      '#description' => t('Values greater than 127 will cause an exception'),
+      '#description' => $this->t('Values greater than 127 will cause an exception'),
     ];
 
     $form['submit'] = [
       '#type' => 'submit',
-      '#value' => t('Update'),
+      '#value' => $this->t('Update'),
     ];
     return $form;
   }
@@ -125,7 +125,7 @@ public function updateCallback(array $form, FormStateInterface $form_state) {
   public function validateForm(array &$form, FormStateInterface $form_state) {
     // Confirm that age is numeric.
     if (!intval($form_state->getValue('age'))) {
-      $form_state->setErrorByName('age', t('Age needs to be a number'));
+      $form_state->setErrorByName('age', $this->t('Age needs to be a number'));
     }
   }
 
@@ -144,7 +144,7 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
       'uid' => $account->id(),
     ];
     $count = DbtngExampleStorage::update($entry);
-    $this->messenger()->addMessage(t('Updated entry @entry (@count row updated)', [
+    $this->messenger()->addMessage($this->t('Updated entry @entry (@count row updated)', [
       '@count' => $count,
       '@entry' => print_r($entry, TRUE),
     ]));