Come faccio ad aggiungere un gestore di convalida personalizzato a un modulo / campo esistente?

Come faccio ad aggiungere un gestore di convalida personalizzato a un modulo esistente (o campo modulo) in Drupal 8?

Ho un modulo che non ho creato. Voglio aggiungere le mie regole di convalida su alcuni campi quando viene inviato il modulo.

Per Drupal 7, convalida personalizzata per un modulo? spiega di implementare hook_form_alter()e quindi aggiungere il gestore di convalida] [1] $form['#validate']all'array, ma in Drupal 8 i moduli sono classi. La convalida viene effettuata tramite il validateForm()metodo e non so come inserire il mio codice.

La #validateproprietà è ancora utilizzata in Drupal 8. (Con la soluzione Adi sostituirai il validatore esistente)

Se vuoi aggiungere il tuo validatore personalizzato oltre a quello predefinito, dovrai aggiungere qualcosa del genere in hook_form_FORM_ID_alter (o simile):

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

Berdir ha dato la risposta corretta, che un vincolo è il modo corretto di aggiungere la convalida a un campo in Drupal 8. Ecco un esempio.

Nell'esempio seguente, lavorerò con un nodo di tipo podcast, che ha il campo a valore singolo field_podcast_duration. Il valore per questo campo deve essere formattato come HH: MM: SS (ore, minuti e secondi).

Per creare un vincolo, è necessario aggiungere due classi. Il primo è la definizione del vincolo e il secondo è il validatore del vincolo. Entrambi sono plugin, nello spazio dei nomi di Drupal\[MODULENAME]\Plugin\Validation\Constraint.

Innanzitutto, la definizione del vincolo. Si noti che l'ID del plug-in è indicato come 'PodcastDuration', nell'annotazione (commento) della classe. Questo sarà usato più in basso.

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';
}

Successivamente, dobbiamo fornire il validatore del vincolo. Questo nome di questa classe sarà il nome della classe dall'alto, con l' Validatoraggiunta ad esso:

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]);
    }
  }
}

Infine, abbiamo bisogno di dire Drupal per usare il nostro vincolo field_podcast_durationsul podcasttipo di nodo. Lo facciamo 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');
  }
}

Il modo corretto per farlo per un'entità di contenuto come il nodo è registrarlo come vincolo.

Vedi forum_entity_bundle_field_info_alter()e il corrispondente? ForumLeafvincolo di validazione (si noti che sono necessarie due classi).

All'inizio è un po 'più complicato, ma il vantaggio è che è integrato nell'API di convalida, quindi la convalida non è limitata al sistema di moduli ma può, ad esempio, funzionare anche con nodi inviati tramite l'API REST.

Voglio aggiungere un po 'più di luce su questo argomento. L'aggiunta della convalida è esattamente la stessa di prima: in hook_form_alter:

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

L'uso dell'oggetto valori all'interno di $ form_state nella funzione validate è però leggermente diverso. per esempio:

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'));
     }

  }
}

Quindi non con un accesso diretto all'oggetto variabili private, ma piuttosto con una funzione getter.

per maggiori informazioni puoi vedere un esempio completo nel mio github: https://github.com/flesheater/drupal8_modules_experiments/blob/master/webham_formvalidation/webham_formvalidation.module

Saluti!

È praticamente lo stesso di D7. Un esempio completo:

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
}

In aggiunta a queste buone risposte aggiungerei:

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

È come chiamare un metodo di classe distante per una convalida del modulo. Penso che sia meglio quindi chiamare una funzione sopra nel file del modulo come nell'esempio fornito.

è possibile utilizzare il modulo di convalida Clientside . Alcuni ulteriori dettagli al riguardo (dalla sua pagina del progetto):

... aggiunge la convalida del client ( nota anche come "convalida del modulo Ajax") per tutti i moduli e i moduli web utilizzando jquery.validate . Il file jquery.validate.js incluso è patchato perché dovevamo poter nascondere messaggi vuoti.