¿Cómo agrego un controlador de validación personalizado a un formulario / campo existente?

¿Cómo agrego un controlador de validación personalizado a un formulario existente (o campo de formulario) en Drupal 8?

Tengo un formulario que no he creado. Quiero agregar mis propias reglas de validación en algunos campos cuando se envíe el formulario.

Para Drupal 7, ¿ Validación personalizada para un formulario? explica implementar hook_form_alter()y luego agregar su controlador de validación] [1] a la $form['#validate']matriz, pero en Drupal 8 los formularios son clases. La validación se realiza a través del validateForm()método y no sé cómo conectar mi código a eso.

La #validatepropiedad todavía se usa en Drupal 8. (Con la solución de Adi, anulará el validador existente)

Si desea agregar su validador personalizado además del predeterminado, deberá agregar algo como esto en hook_form_FORM_ID_alter (o similar):

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

Berdir dio la respuesta correcta, que una restricción es la forma correcta de agregar validación a un campo en Drupal 8. Aquí hay un ejemplo.

En el siguiente ejemplo, trabajaré con un nodo de tipo podcast, que tiene el campo de valor único field_podcast_duration. El valor de este campo debe formatearse como HH: MM: SS (horas, minutos y segundos).

Para crear una restricción, se deben agregar dos clases. El primero es la definición de restricción, y el segundo es el validador de restricción. Ambos son complementos, en el espacio de nombres de Drupal\[MODULENAME]\Plugin\Validation\Constraint.

Primero, la definición de restricción. Tenga en cuenta que la ID del complemento se proporciona como 'PodcastDuration', en la anotación (comentario) de la clase. Esto se usará más abajo.

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

A continuación, debemos proporcionar el validador de restricciones. Este nombre de esta clase será el nombre de la clase de arriba, junto Validatorcon él:

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

Finalmente, necesitamos decirle a Drupal que use nuestra restricción field_podcast_durationen el podcasttipo de nodo. Hacemos esto en 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');
  }
}

La forma correcta de hacer esto para una entidad de contenido como nodo es registrarlo como una restricción.

Ver forum_entity_bundle_field_info_alter()y el correspondiente? ForumLeafrestricción de validación (tenga en cuenta que se necesitan dos clases).

Eso es un poco más complicado al principio, pero la ventaja es que está integrado en la API de validación, por lo que su validación no se limita al sistema de formularios sino que, por ejemplo, también puede funcionar con nodos enviados a través de la API REST.

Quiero agregar algo más de luz sobre este asunto. La adición de la validación es exactamente la misma que antes: en hook_form_alter:

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

Sin embargo, el uso del objeto de valores dentro de $ form_state en la función de validación es un poco diferente. p.ej:

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

  }
}

Entonces, no con un acceso directo al objeto de variables privadas, sino con una función getter.

Para obtener más información, puede ver un ejemplo completo en mi github: https://github.com/flesheater/drupal8_modules_experiments/blob/master/webham_formvalidation/webham_formvalidation.module

¡aclamaciones!

Es muy parecido a D7. Un ejemplo 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
}

En complemento de estas buenas respuestas, agregaría:

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

Es cómo llamar a un método de clase distante para una validación de formulario. Creo que es mejor llamar a una función anterior en el archivo del módulo como en el ejemplo dado.

puede usar el módulo de Validación del lado del cliente . Algunos detalles más al respecto (de su página de proyecto):

... agrega validación del lado del cliente (también conocido como "validación de formulario Ajax") para todos los formularios y formularios web utilizando jquery.validate . El archivo jquery.validate.js incluido está parcheado porque necesitábamos poder ocultar mensajes vacíos.