Wie füge ich einem vorhandenen Formular / Feld einen benutzerdefinierten Validierungshandler hinzu?

Wie füge ich einem vorhandenen Formular (oder Formularfeld) in Drupal 8 einen benutzerdefinierten Validierungshandler hinzu?

Ich habe ein Formular, das ich nicht erstellt habe. Ich möchte meine eigenen Validierungsregeln für einige Felder hinzufügen, wenn das Formular gesendet wird.

Für Drupal 7 Benutzerdefinierte Validierung für ein Formular? erklärt, hook_form_alter()wie Sie Ihren Validierungs-Handler] [1] implementieren und dann zum $form['#validate']Array hinzufügen , aber in Drupal 8 sind Formulare Klassen. Die Validierung erfolgt über die validateForm()Methode und ich weiß nicht, wie ich meinen Code in diese einbinden soll.

Die #validateEigenschaft wird weiterhin in Drupal 8 verwendet. (Mit der Lösung von Adi überschreiben Sie den vorhandenen Validator.)

Wenn Sie Ihren benutzerdefinierten Validator zusätzlich zum Standard hinzufügen möchten, müssen Sie in hook_form_FORM_ID_alter (oder ähnlichem) Folgendes hinzufügen :

$form['#validate'][] = 'my_test_validate';

Berdir gab die richtige Antwort, dass eine Einschränkung der richtige Weg ist, um einem Feld in Drupal 8 eine Validierung hinzuzufügen. Hier ist ein Beispiel.

Im folgenden Beispiel werde ich mit einem Knoten des Typs arbeiten podcast, der das Einzelwertfeld hat field_podcast_duration. Der Wert für dieses Feld muss als HH: MM: SS (Stunden, Minuten und Sekunden) formatiert sein.

Um eine Einschränkung zu erstellen, müssen zwei Klassen hinzugefügt werden. Die erste ist die Einschränkungsdefinition, und die zweite ist die Einschränkungsüberprüfung. Beide sind Plugins im Namespace von Drupal\[MODULENAME]\Plugin\Validation\Constraint.

Erstens die Einschränkungsdefinition. Beachten Sie, dass die Plugin-ID in der Anmerkung (Kommentar) der Klasse als 'PodcastDuration' angegeben ist. Dies wird weiter unten verwendet.

namespace Drupal\[MODULENAME]\Plugin\Validation\Constraint;

use Symfony\Component\Validator\Constraint;

/**
 * Checks that the submitted duration is of the format HH:MM:SS
 *
 * @Constraint(
 *   id = "PodcastDuration",
 *   label = @Translation("Podcast Duration", context = "Validation"),
 * )
 */
class PodcastDurationConstraint extends Constraint {

  // The message that will be shown if the format is incorrect.
  public $incorrectDurationFormat = 'The duration must be in the format HH:MM:SS or HHH:MM:SS. You provided %duration';
}

Als nächstes müssen wir den Constraint Validator bereitstellen. Dieser Name dieser Klasse ist der Klassenname von oben, an den ValidatorFolgendes angehängt ist:

namespace Drupal\[MODULENAME]\Plugin\Validation\Constraint;

use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintValidator;

/**
 * Validates the PodcastDuration constraint.
 */
class PodcastDurationConstraintValidator extends ConstraintValidator {

  /**
   * {@inheritdoc}
   */
  public function validate($items, Constraint $constraint) {
    // This is a single-item field so we only need to
    // validate the first item
    $item = $items->first();

    // If there is no value we don't need to validate anything
    if (!isset($item)) {
      return NULL;
    }

    // Check that the value is in the format HH:MM:SS
    if (!preg_match('/^[0-9]{1,2}:[0-5]{1}[0-9]{1}:[0-5]{1}[0-9]{1}$/', $item->value)) {
      // The value is an incorrect format, so we set a 'violation'
      // aka error. The key we use for the constraint is the key
      // we set in the constraint, in this case $incorrectDurationFormat.
      $this->context->addViolation($constraint->incorrectDurationFormat, ['%duration' => $item->value]);
    }
  }
}

Schließlich müssen wir Drupal anweisen, unsere Einschränkung field_podcast_durationfür den podcastKnotentyp zu verwenden. Wir machen das in hook_entity_bundle_field_info_alter():

use Drupal\Core\Entity\EntityTypeInterface;

function HOOK_entity_bundle_field_info_alter(&$fields, EntityTypeInterface $entity_type, $bundle) {
  if (!empty($fields['field_podcast_duration'])) {
    $fields['field_podcast_duration']->addConstraint('PodcastDuration');
  }
}

Der richtige Weg, dies für eine Inhaltsentität wie einen Knoten zu tun, besteht darin, ihn als Einschränkung zu registrieren.

Siehe forum_entity_bundle_field_info_alter()und die entsprechenden? ForumLeafValidierungsbeschränkung (beachten Sie, dass zwei Klassen erforderlich sind).

Das ist zunächst etwas komplizierter, hat aber den Vorteil, dass es in die Validierungs-API integriert ist, sodass Ihre Validierung nicht auf das Formularsystem beschränkt ist, sondern beispielsweise auch mit über die REST-API gesendeten Knoten funktionieren kann.

Ich möchte etwas mehr Licht in diese Angelegenheit bringen. Das Hinzufügen der Validierung ist genauso wie zuvor: in hook_form_alter:

$form['#validate'][] = '_form_validation_number_title_validate';

Die Verwendung des values-Objekts innerhalb des $ form_state in der validate-Funktion ist jedoch etwas anders. z.B:

function _form_validation_number_title_validate(&$form, \Drupal\Core\Form\FormStateInterface $form_state) {

  if ($form_state->hasValue('title')) {
     $title = $form_state->getValue('title');

     if (!is_numeric($title[0]['value'])) {
        $form_state->setErrorByName('title', t('Your title should be number'));
     }

  }
}

Also nicht mit einem direkten Zugriff auf das private Variablenobjekt, sondern mit einer Getter-Funktion.

Weitere Informationen finden Sie in meinem Github: https://github.com/flesheater/drupal8_modules_experiments/blob/master/webham_formvalidation/webham_formvalidation.module

Prost!

Es ist sehr ähnlich wie in D7. Ein vollständiges Beispiel:

mymodule.module :

use Drupal\Core\Form\FormStateInterface;

/**
 * Implements hook_form_FORM_ID_alter() for the FORM_ID() form.
 */
function mymodule_form_FORM_ID_alter(&$form, FormStateInterface $form_state, $form_id) {
  $form['#validate'][] = '_mymodule_form_FORM_ID_validate';
}

/**
 * Validates submission values in the FORM_ID() form.
 */
function _mymodule_form_FORM_ID_validate(array &$form, FormStateInterface $form_state) {
  // Validation code here
}

Ergänzend zu diesen guten Antworten möchte ich hinzufügen:

$form['#validate'][] = 'Drupal\your_custom_module_name\CustomClass::customValidate';

So rufen Sie eine entfernte Klassenmethode für eine Formularvalidierung auf. Ich denke, es ist besser, als eine obige Funktion in der Moduldatei wie im Beispiel aufzurufen.

Sie können das clientseitige Validierungsmodul verwenden . Einige weitere Details dazu (von der Projektseite):

... fügt mit jquery.validate die clientseitige Validierung (auch "Ajax-Formularvalidierung" genannt) für alle Formulare und Webformulare hinzu . Die enthaltene Datei jquery.validate.js ist gepatcht, da leere Nachrichten ausgeblendet werden mussten.