Berdir deu a resposta correta, que uma restrição é a maneira correta de adicionar validação a um campo no Drupal 8. Aqui está um exemplo.
No exemplo abaixo, trabalharei com um nó do tipo podcast
, que possui o campo de valor único field_podcast_duration
. O valor desse campo precisa ser formatado como HH: MM: SS (horas, minutos e segundos).
Para criar uma restrição, duas classes precisam ser adicionadas. O primeiro é a definição de restrição e o segundo é o validador de restrição. Ambos são plugins, no espaço de nomes de Drupal\[MODULENAME]\Plugin\Validation\Constraint
.
Primeiro, a definição de restrição. Observe que o ID do plug-in é fornecido como 'PodcastDuration', na anotação (comentário) da classe. Isso será usado mais adiante.
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';
}
Em seguida, precisamos fornecer o validador de restrição. Este nome desta classe será o nome da classe acima, com Validator
anexado a ele:
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, nós precisamos dizer Drupal para usar nosso restrição sobre field_podcast_duration
o podcast
tipo de nó. Fazemos isso em 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');
}
}