Updated all the contrib modules to their latest versions.
[yaffs-website] / web / modules / contrib / migrate_tools / src / Form / MigrationGroupFormBase.php
index 30229fe27a0cde8eb65fd399e3c75527cb22a20e..d60944a759fd9c55c4fb79957851437c4fce7e7d 100644 (file)
@@ -6,7 +6,6 @@ use Drupal\Core\Entity\EntityForm;
 use Drupal\Core\Entity\Query\QueryFactory;
 use Drupal\Core\Form\FormStateInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
-use Drupal\migrate_plus\Entity\MigrationGroupInterface;
 
 /**
  * Class MigrationGroupFormBase.
@@ -18,6 +17,8 @@ use Drupal\migrate_plus\Entity\MigrationGroupInterface;
 class MigrationGroupFormBase extends EntityForm {
 
   /**
+   * The query factory service.
+   *
    * @var \Drupal\Core\Entity\Query\QueryFactory
    */
   protected $entityQueryFactory;
@@ -25,10 +26,10 @@ class MigrationGroupFormBase extends EntityForm {
   /**
    * Construct the MigrationGroupFormBase.
    *
-   * For simple entity forms, there's no need for a constructor. Our migration group form
-   * base, however, requires an entity query factory to be injected into it
-   * from the container. We later use this query factory to build an entity
-   * query for the exists() method.
+   * For simple entity forms, there's no need for a constructor. Our migration
+   * group form base, however, requires an entity query factory to be injected
+   * into it from the container. We later use this query factory to build an
+   * entity query for the exists() method.
    *
    * @param \Drupal\Core\Entity\Query\QueryFactory $query_factory
    *   An entity query factory for the migration group entity type.
@@ -38,13 +39,7 @@ class MigrationGroupFormBase extends EntityForm {
   }
 
   /**
-   * Factory method for MigrationGroupFormBase.
-   *
-   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
-   *   A container interface service.
-   *
-   * @return \Drupal\migrate_tools\Form\MigrationFormBase
-   *
+   * {@inheritdoc}
    */
   public static function create(ContainerInterface $container) {
     return new static($container->get('entity.query'));
@@ -67,41 +62,41 @@ class MigrationGroupFormBase extends EntityForm {
     // Get anything we need from the base class.
     $form = parent::buildForm($form, $form_state);
 
-    /** @var MigrationGroupInterface $migration_group */
+    /** @var \Drupal\migrate_plus\Entity\MigrationGroupInterface $migration_group */
     $migration_group = $this->entity;
 
     // Build the form.
-    $form['label'] = array(
+    $form['label'] = [
       '#type' => 'textfield',
       '#title' => $this->t('Label'),
       '#maxlength' => 255,
       '#default_value' => $migration_group->label(),
       '#required' => TRUE,
-    );
-    $form['id'] = array(
+    ];
+    $form['id'] = [
       '#type' => 'machine_name',
       '#title' => $this->t('Machine name'),
       '#default_value' => $migration_group->id(),
-      '#machine_name' => array(
-        'exists' => array($this, 'exists'),
+      '#machine_name' => [
+        'exists' => [$this, 'exists'],
         'replace_pattern' => '([^a-z0-9_]+)|(^custom$)',
         'error' => 'The machine-readable name must be unique, and can only contain lowercase letters, numbers, and underscores. Additionally, it can not be the reserved word "custom".',
-      ),
+      ],
       '#disabled' => !$migration_group->isNew(),
-    );
-    $form['description'] = array(
+    ];
+    $form['description'] = [
       '#type' => 'textfield',
       '#title' => $this->t('Description'),
       '#maxlength' => 255,
       '#default_value' => $migration_group->get('description'),
-    );
-    $form['source_type'] = array(
+    ];
+    $form['source_type'] = [
       '#type' => 'textfield',
       '#title' => $this->t('Source type'),
       '#description' => $this->t('Type of source system the group is migrating from, for example "Drupal 6" or "WordPress 4".'),
       '#maxlength' => 255,
       '#default_value' => $migration_group->get('source_type'),
-    );
+    ];
 
     // Return the form.
     return $form;
@@ -114,7 +109,7 @@ class MigrationGroupFormBase extends EntityForm {
    *   The entity ID.
    * @param array $element
    *   The form element.
-   * @param FormStateInterface $form_state
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
    *   The form state.
    *
    * @return bool
@@ -155,14 +150,7 @@ class MigrationGroupFormBase extends EntityForm {
   }
 
   /**
-   * Overrides Drupal\Core\Entity\EntityFormController::save().
-   *
-   * @param array $form
-   *   An associative array containing the structure of the form.
-   * @param \Drupal\Core\Form\FormStateInterface $form_state
-   *   An associative array containing the current state of the form.
-   *
-   * @return $this
+   * {@inheritdoc}
    */
   public function save(array $form, FormStateInterface $form_state) {
     $migration_group = $this->getEntity();
@@ -170,11 +158,11 @@ class MigrationGroupFormBase extends EntityForm {
 
     if ($status == SAVED_UPDATED) {
       // If we edited an existing entity...
-      drupal_set_message($this->t('Migration group %label has been updated.', array('%label' => $migration_group->label())));
+      drupal_set_message($this->t('Migration group %label has been updated.', ['%label' => $migration_group->label()]));
     }
     else {
       // If we created a new entity...
-      drupal_set_message($this->t('Migration group %label has been added.', array('%label' => $migration_group->label())));
+      drupal_set_message($this->t('Migration group %label has been added.', ['%label' => $migration_group->label()]));
     }
 
     // Redirect the user back to the listing route after the save operation.