Générateur de code Drupal: Exporter des données via Features : API et démonstration

Introduction à Features

Ce générateur de code vous permet d'intégrer votre module à Features, c'est-à-dire d'exporter des configurations ou des éléments de votre module (une ligne de votre table par exemple) via Features. Ce module vous permet ensuite de passer plus facilement entre les divers environnement (développement, préproduction, production, etc.) en réalisant tout simplement des "commits" si vos fichiers sont versionnés, ou en écrasant / ajoutant manuellement les modules créés par Features, puis d'appliquer les changement via l'interface de Features, qui va vous permettre de visualiser ce qui a été modifié, ajouté, changé, etc. avant d'appuyer sur "GO" ! Cf. image ci-contre

Et donc de ne pas prier pour que tout fonctionne quand vous passerez en production vos éléments.

Implémentation de Features dans votre module par le code

Il vous faut, comme souvent en Drupal, créer une déclaration dans votre fichier .module (cf. en en-tête du générateur), puis créer un fichier mon_module.features.inc.

Il vous faut ensuite renseigner ci-dessous un nom de "composant", qui va être in fine un tableau d'informations, par exemple si vous exportez un message de notification, un tableau contenant e-mail, objetc, corps de texte, etc.

Enfin, il va vous falloir créer ou renseigner les fonctions de récupération de vos données et de sauvegarde (en pensant à la fois à l'insertion mais également à la mise à jour). En terme de fonctions de récupération, il vous faut également deux éléments : la récupération des clés / valeurs pour afficher les cases à cocher dans Features, et les données complètes à exporter pour réimport futur.

Attention, Features ne peut fonctionner qu'avec des noms machines unique, et donc ne fonctionnera pas avec des IDs incrémentaux (type 1, 2, 3, etc. au fur et à mesure de la création).

N'hésitez pas à poster dans les commentaires vos propositions pour améliorer ce code !

// ---------------------------------------  COLLER DANS LE .module -------------------------------------------

/**
 * Implementation of hook_features_api().
 *
 * Here we define the components that we want to make exportable.  For this
 * particular module, we want to make the configurations exportable.
 */
function mon_module_features_api() {
  // You can declare more than one exportable component
  return array(
    'mon_composant' => array(
      'name' => 'Mon composant',
      'file' => drupal_get_path('module', 'mon_module') . '/mon_module.features.inc',
      'default_hook' => 'mon_module_config_features_default_settings',
      'feature_source' => TRUE,
    ),
  );
}

//---------------------------------------------- COLLER DANS LE FICHIER mon_module.features.inc

/**
 * Implementation of  [component]_features_export_options  [component_hook].
 *
 * This hook will alert features of which specific items of this component may
 * be exported. For instances, in this case, we want to make available all the
 * existing items.  If there are no items to be exported, this component will
 * not be made available in the features export page.
 *
 * @return array
 *   A keyed array of items, suitable for use with a FormAPI select or
 *   checkboxes element.
 */
function mon_composant_features_export_options() {

// Get the title and machine names of the elements to export.
  $options = array();
  $result = db_select('ma_table', 't')->fields('t', array('machine_name', 'title'))->execute();

foreach ($result as $record) {
    $options[$record->machine_name] = $record->title;
  }
  
  return $options;
}

/**
 * Implementation of  [component]_features_export  [component_hook].
 *
 * This is a component hook, rather then a module hook, therefore this is the
 * callback from hook_features_api which relates to the specific component we
 * are looking to export.  When a specific instance of the component we are
 * looking to export is selected, this will include the necessariy item, plus
 * any dependencies into our export array.
 *
 * @param array $data
 *   this is the machine name for the component in question
 * @param array &$export
 *   array of all components to be exported
 * @param string $module_name
 *   The name of the feature module to be generated.
 * @return array
 *   The pipe array of further processors that should be called
 */
function mon_composant_features_export($data, &$export, $module_name = '') {

// Add dependency to the module.
  // Possible to add anything else.
  $export['dependencies']['mon_module'] = 'mon_module';

// Add all machine names of our component.
  foreach ($data as $component) {
    $export['features']['mon_composant'][$component] = $component;
  }

return array();
}

/**
 *  Implementation of [component]_features_export_render()  [component_hook].
 */
function mon_composant_features_export_render($module_name, $data, $export = NULL) {
  // Creation of a code snippet (an array) for features.
  $code = array();
  $code[] = '  $mon_composants = array();';
  $code[] ='';
  foreach ($data as $sys_name) {
    $ids[] = $sys_name;
  }

$load = (array) ma_fonction_load_multiple($ids);
  
  foreach ($load AS $key => $value) {
    $code[] = '$mon_composants[\'' . $key . '\'] = ' . features_var_export($value, '  ') .';';
  }
  
  $code[] = 'return $mon_composants;';
  $code = implode("\n  ", $code);
  
  return array('mon_module_config_features_default_settings' => $code);
}

/**
 * Implementation of [component]_features_revert().  [component_hook]
 */
function mon_composant_features_revert($module) {
  mon_composant_features_rebuild($module);
}

/**
 * Implementation of [component]_features_rebuild().  [component_hook]
 */
function mon_composant_features_rebuild($module) {
  $items = module_invoke($module, 'mon_module_config_features_default_settings');
  // loop over the items we need to recreate
  foreach ($items as $idx => $item) {
    $save[] = $item;
  }
  ma_fonction_save_multiple($save);
}

Introduction à Features

Implémentation de Features dans votre module par le code

Ajouter un commentaire

Texte simple