Бердір дав правильну відповідь, що обмеження - це правильний спосіб додати валідацію до поля в Drupal 8. Ось приклад.
У наведеному нижче прикладі я буду працювати з вузлом типу podcast
, який має поле єдиного значення field_podcast_duration
. Значення для цього поля потрібно відформатувати як HH: MM: SS (години, хвилини та секунди).
Для створення обмеження потрібно додати два класи. Перше - визначення обмеження, а друге - валідатор обмежень. Обидва ці плагіни в просторі імен Drupal\[MODULENAME]\Plugin\Validation\Constraint
.
По-перше, визначення обмеження. Зауважте, що ідентифікатор плагіна подається як "PodcastDuration" в анотації (коментарі) до класу. Це буде використано далі вниз.
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';
}
Далі нам потрібно надати валідатор обмежень. Ця назва цього класу буде назвою класу зверху та Validator
додається до нього:
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]);
}
}
}
Нарешті, ми повинні сказати Drupal використовувати наше обмеження на field_podcast_duration
на podcast
типі вузла. Ми робимо це в 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');
}
}