Module Drupal File History

Créer un champs de type file_history

L'implémentation de ce type de champs est très proche et étend celle utilisé pour le type de champ managed_file.

A minima, le champ ne demande que les attributs utilisé par managed_file. Un certain nombre de nouveaux attributs sont disponibles.

Dans le cas présenté, une validation spécifique my_custom_validator à été ajouter aux validateurs.

Les attributs no_upload, no_use, no_download permettent d’activer ou non certaines fonctionnalités du tableau correspondant à l’interface utilisateur du champs.

  $validators = [
    'file_validate_extensions' => ['xls xlsx xml txt'],
    'file_validate_size' => [Environment::getUploadMaxSize()],
    'my_custom_validator' => ['paramOne'],
  ];

  $form['configurations_files'] = [
    '#type' => 'file_history',
    '#title' => $this->t('Configurations'),
    '#description' => $this->t('List of files'),
    '#size' => 50,

    // Like Managed Files, general file validation.
    '#upload_validators' => $validators,

    // Folder to store files.
    '#upload_location' => 'public://my_configuration/',

    '#cardinality' => 2,
    '#default_value' => (is_array($default) ? $default : []),

    // Setting an id for the wrapper will activate ajax on buttons.
    '#theme_wrappers' => [
      'form_element' => [
        '#wrapper_attributes' => ['id' => 'change-this-id-wrapper'],
      ],
    ],
  ];

Validation et soumission du champ

Pour la validation et la soumission, la valeur contenu dans le champs est structuré en deux partie.

L’attribut selected contient la liste des fichiers qui ont été marqué comme « sélectionné » dans l’interface utilisateur.

L’attribut in_table contient la liste de toutes les fichiers présents dans la table (sélectionnée ou non).

  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);

    $value = $form_state->getValue('configurations_files');

    // Do something on submit.
    $selected = $value['selected'];
    $table_state = $value['in_table'];

    $this->config('exemple_file_history.default')
      ->set('selected_configuration_file', $selected)
      ->set('loaded_configuration_file', $table_state)
      ->save();
  }

Implémentation avancée

Le module propose 3 familles de hook_alter.

• La famille des hook_file_history_headers_alter et hook_file_history_FIELD_ID_headers_alter permettent de modifier les en-têtes de la table.

• La famille des hook_file_history_rows_alter et hook_file_history_FIELD_ID_rows_alter permettent de modifier le contenu même de la table.

• La troisième famille est dédié à l’utilisation du champ via le widget et permet d’ajouter des validateur pour l’upload des fichiers. Ce sont les hook_file_history_validator_alter et hook_file_history_FIELD_DEFINITION_ID_validator_alter.