mcpField
D
drupal-form-validation

drupal-form-validation

github.com/edutrul開発7349 回インストール21 週間前に更新
リポジトリ

drupal-form-validation について

drupal-form-validationは、Drupalフォーム入力を検証する開発スキルです。フォーム単位・要素単位の検証、条件付きルール、値の取得、フォーム変更によるバリデーター追加を扱います。

主な機能

  1. 01validateForm()での値の検証
  2. 02名前付き・ネスト要素へのエラー設定
  3. 03要素固有のバリデーター追加
  4. 04条件付き検証ルールの適用
  5. 05hook_form_alterによるバリデーター追加

活用シーン

  1. 01選択したフォーム種別でURLを必須にする
  2. 02フィールドの形式や長さを検証する
  3. 03ネスト要素にエラーを設定する
  4. 04既存フォームに独自チェックを追加する

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/edutrul/drupal-ai --skill drupal-form-validation

インストール後、Claude Code で/drupal-form-validationを入力して読み込まれたか確認します。

同梱ファイルREADME.md

詳細

Drupal フォームの検証

validateForm() メソッド

public function validateForm(array &$form, FormStateInterface $form_state): void {
  $name = $form_state->getValue('name');

  if (strlen($name) < 3) {
    $form_state->setErrorByName('name', $this->t('Name must be at least 3 characters.'));
  }

  if (!preg_match('/^[a-zA-Z\s]+$/', $name)) {
    $form_state->setErrorByName('name', $this->t('Name may only contain letters and spaces.'));
  }
}

setError と setErrorByName

// Target a specific form element by name
$form_state->setErrorByName('field_date', $this->t('Invalid date.'));

// Target a nested element
$form_state->setErrorByName('field_date][0][value', $this->t('Invalid date.'));

// Target a specific render element directly
$form_state->setError($form['field_date'], $this->t('Invalid date.'));

#element_validate

バリデーターを要素に直接追加します。

$form['email'] = [
  '#type' => 'email',
  '#title' => $this->t('Email'),
  '#element_validate' => [
    [static::class, 'validateUniqueEmail'],
  ],
];

public static function validateUniqueEmail(array &$element, FormStateInterface $form_state, array &$form): void {
  $email = $element['#value'];
  // Check uniqueness...
  if ($emailExists) {
    $form_state->setError($element, t('This email is already registered.'));
  }
}

条件付き検証

public function validateForm(array &$form, FormStateInterface $form_state): void {
  $type = $form_state->getValue('type');

  if ($type === 'external') {
    $url = $form_state->getValue('url');
    if (empty($url)) {
      $form_state->setErrorByName('url', $this->t('URL is required for external type.'));
    }
    elseif (!UrlHelper::isValid($url, TRUE)) {
      $form_state->setErrorByName('url', $this->t('Please enter a valid URL.'));
    }
  }
}

検証時の値へのアクセス

// Get a single value
$value = $form_state->getValue('my_field');

// Get nested value
$value = $form_state->getValue(['field_date', 0, 'value']);

// Get all values
$values = $form_state->getValues();

// Check if field has errors
if ($form_state->getError($form['my_field'])) { ... }

hook_form_alter による検証の追加

#[Hook('form_node_article_form_alter')]
public function formNodeArticleFormAlter(array &$form, FormStateInterface $form_state): void {
  // Add before existing validators
  array_unshift($form['#validate'], [static::class, 'validateArticle']);

  // Add after existing validators
  $form['#validate'][] = [static::class, 'validateArticle'];
}

public static function validateArticle(array &$form, FormStateInterface $form_state): void {
  // Validation logic here.
}

コメント